Объект Scene представляет собой загруженную в настоящий момент сцену. Всегда существует один и только один объект Scene, к которому можно получить доступ посредством атрибута Game.Scene. Для совместимости этот объект также автоматически сохраняется в глобальной переменной Scene.
Манипулирование объектами | |
LoadActor | Загружает персонаж из файла. |
LoadActor3D | Загружает 3D-персонаж из файла. |
LoadEntity | Загружает объект сцены (entity) из файла. |
UnloadObject | Удаляет объект из памяти. |
Функции прокрутки | |
SkipTo | Задаёт текущую позицию прокрутки сцены в указанной точке / объекте. |
ScrollTo | Прокручивает сцену до указанной точки / объекта. |
Сбор информации об узлах сцены | |
GetLayer | Возвращает слой в качестве объекта. |
GetWaypointGroup | Возвращает группу точек нахождения пути в качестве объекта. |
GetNode | Возвращает узел сцены (объект сцены (entity) или регион). |
GetFreeNode | Возвращает свободный узел сцены (объект сцены (entity) или персонаж). |
GetRegionAt | Возвращает регион сцены. |
Сбор информации о сцене | |
IsBlockedAt | Выясняет, является ли сцена заблокированной (непроходимой) в указанной точке. |
IsWalkableAt | Выясняет, является ли сцена проходимой в указанной точке. |
GetScaleAt | Возвращает уровень масштабирования в указанной точке. |
GetRotationAt | Возвращает фактор вращения спрайтов в указанной точке. |
IsPointInViewport | Выясняет, находится ли указанная точка в области отображения сцены. |
Эффект затуманивания | |
FadeOut | Затуманивает сцену указанным цветом. |
FadeIn | Прояснивает (туман рассеивается) сцену из заданного цвета. |
GetFadeColor | Возвращает текущий цвет тумана. |
Динамическое создание объектов | |
CreateEntity | Создаёт новый объект сцены (entity). |
DeleteEntity | Удаляет объект сцены (entity). |
AddLayer | Создаёт новый слой (самый верхний). |
InsertLayer | Вставляет новый слой в сцену. |
DeleteLayer | Удаляет слой сцены. |
3D-функции | |
EnableNode3D | Включает проходимую область или блок-объект. |
DisableNode3D | Отключает проходимую область или блок-объект. |
IsNode3DEnabled | Выясняет, включён ли указанный проходимый регион или блок-объект. |
EnableLight | Включает источник света. |
DisableLight | Отключает источник света. |
IsLightEnabled | Выясняет, включён ли указанный источник света. |
SetLightColor | Изменяет цвет источника света. |
GetLightColor | Возвращает цвет источника света. |
GetLightName | Возвращает имя источника света. |
SetActiveCamera | Переключает камеру, которая будет использоваться для отображения 3D-объектов в сцене. |
EnableFog | Включает линейный туман, который имеет эффект на 3D-персонажах. |
DisableFog | Отключает туман. |
Разные функции | |
SetViewport | Задаёт область отображения сцены. |
Type (только для чтения) | Всегда возвращает "scene". |
Name | Внутреннее имя сцены. |
Filename (только для чтения) | Возвращает имя файла сцены. |
Ready (только для чтения) | Возвращает true, если сцена находится в состоянии готовности (скроллинг закончен). |
NumLayers (только для чтения) | Возвращает количество слоёв. |
NumWaypointGroups (только для чтения) | Возвращает количество групп точек нахождения пути. |
MouseX (только для чтения) | Возвращает координату X текущей позиции курсора мыши внутри сцены. |
MouseY (только для чтения) | Возвращает координату Y текущей позиции курсора мыши внутри сцены. |
MainLayer (только для чтения) | Возвращает ссылку на основной (главный) слой сцены. |
AutoScroll | Указывает, должна ли сцена автоматически прокручиваться до объекта Game.MainObject |
IsScrolling (только для чтения) | Возвращает true, если сцена в настоящий момент прокручивается. |
PersistentState | Указывает, должен ли движок "запоминать" предыдущие состояния узлов сцены, когда пользователь повторно посещает её. |
ScrollSpeedX | Горизонтальная скорость прокрутки (в мс, по умолчанию = 10). |
ScrollSpeedY | Вертикальная скорость прокрутки (в мс, по умолчанию = 10). |
ScrollPixelsX | Горизонтальное смещение при прокрутке (в пикселях, по умолчанию = 1). |
ScrollPixelsY | Вертикальное смещение при прокрутке (в пикселях, по умолчанию = 1). |
OffsetX | Текущее горизонтальное смещение сцены (до какой позиции она прокручена). |
OffsetY | Текущее вертикальное смещение сцены. |
Width | Ширина главного слоя сцены. |
Height | Высота главного слоя сцены. |
NumFreeNodes (только для чтения) | Количество свободных узлов сцены. |
GeometryFile (только для чтения) | Имя файла геометрии, привязанного к сцене, или null, если такового не имеется. |
ShowGeometry | Указывает, нужно ли отображать геометрию сцены (для отладочных целей) |
MaxShadowType | Максимальный уровень детализации теней в сцене (0..нет (none), 1..простая (simple), 2..плоская (flat), 3..шаблонная (stencil)) |
AmbientLightColor | Цвет охватывающего сцену света (влияет на 3D-персонажей). |
NumLights (только для чтения) | Количество источников света, заданных геометрией сцены. |
SceneShutdown | Генерируется в момент перед выгрузкой сцены из памяти. Обработчик этого события не должен содержать никаких блокирующих команд, вроде Sleep(), GoTo() и т. д. |
Загружает персонаж из файла.
Ссылка на объект Actor. Если метод не сможет создать объект, он вернёт значение null.
Персонажи, загруженные с помощью данного метода, будут автоматически выгружаться при смене сцены (в отличие от метода Game.LoadActor).
Загружает 3D-персонаж из файла.
Ссылка на объект 3D actor. Если метод не сможет создать объект, он вернёт значение null.
Персонажи, загруженные с помощью данного метода, будут автоматически выгружаться при смене сцены (в отличие от метода Game.LoadActor3D).
Загружает объект сцены (entity) из файла.
Ссылка на объект Entity. Если метод не сможет создать объект, он вернёт значение null.
Объекты сцены, загруженные с помощью данного метода, будут автоматически выгружаться при смене сцены (в отличие от метода Game.LoadEntity).
Удаляет объект из памяти.
Если Вы загружаете объекты с помощью методов Scene.LoadActor или Scene.LoadEntity, то Вам следует выгружать их из памяти после того, как они будут больше не нужны. Иначе эти объекты будут ликвидированы только при смене сцены.
Задаёт текущую позицию прокрутки сцены в указанной точке / объекте.
Прокручивает сцену до указанной точки / объекта.
Чтобы данный метод работал, атрибут Scene.AutoScroll должен быть установлен в true.
Возвращает слой в качестве объекта.
Ссылка на объект layer с указанным индексом/именем или null, если указанный слой не существует.
Возвращает группу точек нахождения пути в качестве объекта.
Ссылка на объект группы точек с заданным индексом или null, если указанная группа не существует.
Возвращает узел сцены (объект сцены (entity) или регион).
Ссылка на объект узла сцены или null, если указанный узел не существует.
Чтобы данный метод работал корректно, каждый узел сцены должен иметь уникальное имя.
Возвращает свободный узел сцены (объект сцены (entity) или персонаж).
Ссылка на объект узла сцены или null, если указанный узел не существует.
Возвращает регион сцены.
Ссылка на объект региона или null, если указанный регион не существует.
Выясняет, является ли сцена заблокированной (непроходимой) в указанной точке.
true, если сцена заблокирована в указанной точке.
Выясняет, является ли сцена проходимой в указанной точке.
true, если сцена проходима в указанной точке.
Возвращает уровень масштабирования в указанной точке.
Уровень масштабирования в процентах.
Возвращает фактор вращения спрайтов в указанной точке.
Фактор вращения спрайтов в градусах.
Выясняет, находится ли указанная точка в области отображения сцены.
true, если указанная точка находится в области отображения сцены.
Затуманивает сцену указанным цветом.
Метод FadeOut блокирует выполнение сценария до тех пор, пока процесс затуманивания не будет завершён, метод FadeOutAsync работает параллельно со сценарием.
Прояснивает (туман рассеивается) сцену из заданного цвета.
Метод FadeIn блокирует выполнение сценария до тех пор, пока процесс прояснивания не будет завершён, метод FadeInAsync работает параллельно со сценарием.
Возвращает текущий цвет тумана.
Цвет тумана в цветовом числовом формате (RGB).
Вы можете использовать методы GetRValue(), GetGValue(), GetBValue() и GetAValue() для получения конкретных составляющих цвета.
Создаёт новый объект сцены (entity).
Ссылка на вновь созданный объект.
Удаляет объект сцены (entity).
Создаёт новый слой (самый верхний).
Ссылка на созданный объект layer.
Вставляет новый слой в сцену.
Ссылка на созданный объект layer.
Удаляет слой сцены.
true, если удаление было успешно выполнено.
Включает проходимую область или блок-объект.
true, если узел был успешно включён.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии.
Отключает проходимую область или блок-объект.
true, если узел был успешно отключён.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии.
Выясняет, включён ли указанный проходимый регион или блок-объект.
true, если указанный узел включён.
Включает источник света.
true в случае успеха.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии.
Отключает источник света.
true в случае успеха.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии.
Выясняет, включён ли указанный источник света.
true если указанный источник света существует и включён (доступен).
Изменяет цвет источника света.
true в случае успеха.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии.
Возвращает цвет источника света.
Цвет источника в формате RGB.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии. Вы можете использовать методы GetRValue(), GetGValue(), GetBValue() и GetAValue() для получения конкретных составляющих цвета.
Возвращает имя источника света.
Имя источника света с указанным индексом или null, если источник с таким индексом не существует.
Вы можете использовать цикл от 0 до Scene.NumLights - 1, чтобы получить имена всех существующих источников света в сцене.
Переключает камеру, которая будет использоваться для отображения 3D-объектов в сцене.
true в случае успеха.
Для работы данного метода требуется наличие привязанного к сцене файла 3D-геометрии.
Включает линейный туман, который имеет эффект на 3D-персонажах.
Используйте функцию MakeRGBA() для приведения значений цвета к формату RGB.
Отключает туман.
Задаёт область отображения сцены.
Этот метод влияет только на текущую сцену (в отличие от метода Game.SetSceneViewport). Вызвав этот метод без параметров, Вы можете задать область отображения на полный экран.