Parallax2D — C# API

Узел, используемый для создания параллаксного прокручиваемого фона.

class Parallax2DReckfellSharpНаследует Entity2D

Узел, используемый для создания параллаксного прокручиваемого фона.

Parallax2D используется для создания эффекта параллакса. Он может двигаться с разной скоростью относительно движения камеры с помощью Parallax2D.ScrollScale. Это создает иллюзию глубины в 2D-игре. Если требуется ручная прокрутка, положение Camera2D можно игнорировать с помощью Parallax2D.IgnoreCameraScroll. Примечание: Любые изменения положения этого узла, внесенные после того, как он вошел в дерево сцены, будут переопределены, если Parallax2D.IgnoreCameraScroll равно false или Parallax2D.ScreenOffset изменено.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

Parallax2DКонструктор

# Parallax2D

C#
public Parallax2D();

Свойства10

AutoscrollСвойство

# Autoscroll

C#
public Vector2 Autoscroll { get; set; }

Скорость, с которой смещение прокручивается автоматически, в пикселях в секунду.

FollowViewportСвойство

# FollowViewport

C#
public bool FollowViewport { get; set; }

Если true, этот Parallax2D смещен на текущую позицию камеры. Если Parallax2D находится в CanvasLayer отдельно от текущей камеры, может быть желательно сопоставить значение с CanvasLayer.FollowViewportEnabled.

IgnoreCameraScrollСвойство

# IgnoreCameraScroll

C#
public bool IgnoreCameraScroll { get; set; }

Если true, положение Parallax2D не зависит от положения камеры.

LimitBeginСвойство

# LimitBegin

C#
public Vector2 LimitBegin { get; set; }

Верхний левый предел для начала прокрутки. Если камера выходит за пределы этого предела, Parallax2D останавливает прокрутку. Должно быть меньше, чем Parallax2D.LimitEnd минус размер области просмотра, чтобы работать.

LimitEndСвойство

# LimitEnd

C#
public Vector2 LimitEnd { get; set; }

Нижний правый предел для прокрутки до конца. Если камера находится за пределами этого предела, Parallax2D остановит прокрутку. Должно быть больше, чем Parallax2D.LimitBegin и размер области просмотра, объединенные для работы.

RepeatSizeСвойство

# RepeatSize

C#
public Vector2 RepeatSize { get; set; }

Повторяет Texture2D каждого из дочерних узлов этого узла и смещает их на это значение. При прокрутке положение узла зацикливается, создавая иллюзию бесконечного прокручивающегося фона, если значения больше размера экрана. Если ось установлена на 0, Texture2D не будет повторяться.

RepeatTimesСвойство

# RepeatTimes

C#
public int RepeatTimes { get; set; }

Переопределяет количество повторений текстуры. Каждая копия текстуры равномерно распространяется от оригинала на Parallax2D.RepeatSize. Полезно при уменьшении масштаба с помощью камеры.

ScreenOffsetСвойство

# ScreenOffset

C#
public Vector2 ScreenOffset { get; set; }

Смещение, используемое для прокрутки этого Parallax2D. Это значение обновляется автоматически, если только Parallax2D.IgnoreCameraScroll не равен true.

ScrollOffsetСвойство

# ScrollOffset

C#
public Vector2 ScrollOffset { get; set; }

Смещение Parallax2D. Аналогично Parallax2D.ScreenOffset и Entity2D.Position, но не будет переопределено. Примечание: Значения будут цикличными, если Parallax2D.RepeatSize будет установлен выше, чем 0.

ScrollScaleСвойство

# ScrollScale

C#
public Vector2 ScrollScale { get; set; }

Множитель для конечного смещения Parallax2D. Может использоваться для имитации расстояния от камеры. Например, значение 1 прокручивает с той же скоростью, что и камера. Значение больше 1 прокручивает быстрее, делая объекты ближе. Меньше 1 прокручивает медленнее, делая объекты дальше, а значение 0 полностью останавливает объекты.

Методы20

GetAutoscrollVector2

# GetAutoscroll

C#
public Vector2 GetAutoscroll();

Возвращает Vector2

GetFollowViewportbool

# GetFollowViewport

C#
public bool GetFollowViewport();

Возвращает bool

GetLimitBeginVector2

# GetLimitBegin

C#
public Vector2 GetLimitBegin();

Возвращает Vector2

GetLimitEndVector2

# GetLimitEnd

C#
public Vector2 GetLimitEnd();

Возвращает Vector2

GetRepeatSizeVector2

# GetRepeatSize

C#
public Vector2 GetRepeatSize();

Возвращает Vector2

GetRepeatTimesint

# GetRepeatTimes

C#
public int GetRepeatTimes();

Возвращает int

GetScreenOffsetVector2

# GetScreenOffset

C#
public Vector2 GetScreenOffset();

Возвращает Vector2

GetScrollOffsetVector2

# GetScrollOffset

C#
public Vector2 GetScrollOffset();

Возвращает Vector2

GetScrollScaleVector2

# GetScrollScale

C#
public Vector2 GetScrollScale();

Возвращает Vector2

IsIgnoreCameraScrollbool

# IsIgnoreCameraScroll

C#
public bool IsIgnoreCameraScroll();

Возвращает bool

SetAutoscrollvoid

# SetAutoscroll

C#
public void SetAutoscroll(Vector2 autoscroll);

Параметры
Имя	Тип	По умолчанию
`autoscroll`	`Vector2`	—

SetFollowViewportvoid

# SetFollowViewport

C#
public void SetFollowViewport(bool follow);

Параметры
Имя	Тип	По умолчанию
`follow`	`bool`	—

SetIgnoreCameraScrollvoid

# SetIgnoreCameraScroll

C#
public void SetIgnoreCameraScroll(bool ignore);

Параметры
Имя	Тип	По умолчанию
`ignore`	`bool`	—

SetLimitBeginvoid

# SetLimitBegin

C#
public void SetLimitBegin(Vector2 offset);

Параметры
Имя	Тип	По умолчанию
`offset`	`Vector2`	—

SetLimitEndvoid

# SetLimitEnd

C#
public void SetLimitEnd(Vector2 offset);

Параметры
Имя	Тип	По умолчанию
`offset`	`Vector2`	—

SetRepeatSizevoid

# SetRepeatSize

C#
public void SetRepeatSize(Vector2 repeatSize);

Параметры
Имя	Тип	По умолчанию
`repeatSize`	`Vector2`	—

SetRepeatTimesvoid

# SetRepeatTimes

C#
public void SetRepeatTimes(int repeatTimes);

Параметры
Имя	Тип	По умолчанию
`repeatTimes`	`int`	—

SetScreenOffsetvoid

# SetScreenOffset

C#
public void SetScreenOffset(Vector2 offset);

Параметры
Имя	Тип	По умолчанию
`offset`	`Vector2`	—

SetScrollOffsetvoid

# SetScrollOffset

C#
public void SetScrollOffset(Vector2 offset);

Параметры
Имя	Тип	По умолчанию
`offset`	`Vector2`	—

SetScrollScalevoid

# SetScrollScale

C#
public void SetScrollScale(Vector2 scale);

Параметры
Имя	Тип	По умолчанию
`scale`	`Vector2`	—