CreateEntity

CreateEntity()

Синтаксис

Result = CreateEntity(#Entity , MeshID , MaterialID , [x , y , z [, PickMask [, VisibilityMask]])

Описание

Создает новую Сущность (Entity), используя указанные Сетку (Mesh) и Материал.

Параметры

#Entity Номер для идентификации новой Сущности. В качестве этого параметра можно использовать значение #PB_Any, чтобы сгенерировать этот Номер автоматически.

MeshID Сетка, используемая для создания Сущности. Чтобы получить действительный идентификатор Сетки, используйте команду MeshID(). Динамические Сетки не поддерживаются (созданные с флагом #PB_Mesh_Dynamic).

MaterialID Идентификатор Материала, используемого при создании Сущности. Этот идентификатор можно получить с помощью команды MaterialID(). В качестве этого параметра можно указать значение #PB_Material_None, чтобы использовать скрипт .material, связанный с Сеткой.
Перед использованием #PB_Material_None должна быть вызвана команда Parse3DScripts().

x, y, z (дополн.) Позиция новой Сущности в 3D-Мире. (по умолчанию 0,0,0)
PickMask (дополн.)
Специальное значение, используемое RayPick() и MousePick() для выбора группы Сущностей, которая будет обрабатываться.
Так как это маска, каждое значение должно быть степенью двойки, всего доступен 31 вариант различающихся масок.
Чтобы легко создать значение маски, можно использовать оператор '<<':
  - 1 << 1  : Первое корректное значение маски.
  - 1 << 2  : Второе корректное значение маски.
  - 1 << 3  : Третье корректное значение маски.
  - ...
  - 1 << 31 : Последнее корректное значение маски.
Для упрощения, используйте константы для хранения значения маски.
При вызове функций выбора маски, маски могут быть объединены с помощью оператора '|', чтобы выбрать более одного типа Сущностей.
VisibilityMask (дополн.) Маска для выбора камеры, на которой должна отображаться Сущность. Если эта маска соответствует маске, указанной в команде CreateCamera(), Сущность будет отображаться на камере. Смотрите описание параметра 'PickMask' для создания корректных масок. Если этот параметр не указан, то Сущность будет видна на всех камерах.

Возвращаемое значение

Возвращает ненулевое значение в случае успеха, в противном случае 0.
Если Сущность с таким Номером уже была создана, она автоматически удаляется и заменяется новой.
Если в качестве параметра '#Entity' использовалось значение #PB_Any, то будет возвращён сгенерированный Номер для созданной Сущности.

См. также

FreeEntity(), HideEntity(), IsEntity()

Поддерживаемые OS

Все

<- CopyEntity() - Entity Index - CreateEntityBody() ->

#Entity	Номер для идентификации новой Сущности. В качестве этого параметра можно использовать значение #PB_Any, чтобы сгенерировать этот Номер автоматически.
MeshID	Сетка, используемая для создания Сущности. Чтобы получить действительный идентификатор Сетки, используйте команду MeshID(). Динамические Сетки не поддерживаются (созданные с флагом #PB_Mesh_Dynamic).
MaterialID	Идентификатор Материала, используемого при создании Сущности. Этот идентификатор можно получить с помощью команды MaterialID(). В качестве этого параметра можно указать значение #PB_Material_None, чтобы использовать скрипт .material, связанный с Сеткой. Перед использованием #PB_Material_None должна быть вызвана команда Parse3DScripts().
x, y, z (дополн.)	Позиция новой Сущности в 3D-Мире. (по умолчанию 0,0,0)
PickMask (дополн.)	Специальное значение, используемое RayPick() и MousePick() для выбора группы Сущностей, которая будет обрабатываться. Так как это маска, каждое значение должно быть степенью двойки, всего доступен 31 вариант различающихся масок. Чтобы легко создать значение маски, можно использовать оператор '<<': - 1 << 1 : Первое корректное значение маски. - 1 << 2 : Второе корректное значение маски. - 1 << 3 : Третье корректное значение маски. - ... - 1 << 31 : Последнее корректное значение маски. Для упрощения, используйте константы для хранения значения маски. При вызове функций выбора маски, маски могут быть объединены с помощью оператора '\|', чтобы выбрать более одного типа Сущностей.
VisibilityMask (дополн.)	Маска для выбора камеры, на которой должна отображаться Сущность. Если эта маска соответствует маске, указанной в команде CreateCamera(), Сущность будет отображаться на камере. Смотрите описание параметра 'PickMask' для создания корректных масок. Если этот параметр не указан, то Сущность будет видна на всех камерах.