Enfusion Script API
Loading...
Searching...
No Matches
Classes | Enumerations
Entities

Classes

interface  EntityComponentPrefabData
 Shared object with constant data for components from prefab. More...
 
interface  EntityPrefabData
 Shared object with constant data for enf::EntitySource from prefab. More...
 
interface  IEntity
 
interface  BaseWeatherManagerEntityClass
 
interface  BaseWeatherManagerEntity
 
interface  CharacterEntityClass
 
interface  CharacterEntity
 
interface  CinematicEntityClass
 
interface  CinematicEntity
 
interface  DecalEntityClass
 
interface  DecalEntity
 
interface  DeferredDecalEntityClass
 
interface  DeferredDecalEntity
 
interface  EnvironmentProbeEntityClass
 
interface  EnvironmentProbeEntity
 
interface  GeneratorBaseEntityClass
 
interface  GeneratorBaseEntity
 
interface  GenericControllerClass
 
interface  GenericController
 
interface  GenericEntity
 Base entity class. More...
 
interface  GenericTerrainEntityClass
 
interface  GenericTerrainEntity
 
interface  GenericWorldEntityClass
 
interface  GenericWorldEntity
 
interface  GenericWorldFogEntityClass
 
interface  GenericWorldFogEntity
 
interface  GenericWorldLightEntityClass
 
interface  GenericWorldLightEntity
 
interface  GenericWorldPPEffectClass
 
interface  GenericWorldPPEffect
 
interface  GenericWorldRainEntityClass
 
interface  GenericWorldRainEntity
 
interface  GenericWorldWindEntityClass
 
interface  GenericWorldWindEntity
 
interface  LakeGeneratorEntityClass
 
interface  LakeGeneratorEntity
 
interface  LightEntityClass
 
interface  LightEntity
 Use LightEntity::CreateLight instead of spawning LightEntity via Game::SpawnEntity for the creation of light in a script. More...
 
interface  PawnEntityClass
 
interface  PawnEntity
 
interface  PawnRelatedEntityClass
 
interface  PawnRelatedEntity
 
interface  PolylineShapeEntityClass
 
interface  PolylineShapeEntity
 
interface  ProbeVolumeClass
 
interface  ProbeVolume
 
interface  RagdollTestEntityClass
 
interface  RagdollTestEntity
 
interface  RiverEntityClass
 
interface  RiverEntity
 Entity for a single river. More...
 
interface  RiverPartEntityClass
 
interface  RiverPartEntity
 River part entity. More...
 
interface  RoadEntityClass
 
interface  RoadEntity
 
interface  RplTestEntityClass
 
interface  RplTestEntity
 Used for testing CPP side of replication. More...
 
interface  ShapeEntityClass
 
interface  ShapeEntity
 
interface  SplineShapeEntityClass
 
interface  SplineShapeEntity
 
interface  SplineTerrainGeneratorEntityBaseClass
 
interface  SplineTerrainGeneratorEntityBase
 
interface  StaticModelEntityClass
 
interface  StaticModelEntity
 
interface  TreeEntity
 
interface  TreeEntityClass
 
interface  VolumeEntityClass
 
interface  VolumeEntity
 
interface  VolumeReceiverEntityClass
 
interface  VolumeReceiverEntity
 
interface  WorldOccluderEntityClass
 
interface  WorldOccluderEntity
 

Enumerations

enum  EAddChildFlags { EAddChildFlags.NONE , EAddChildFlags.AUTO_TRANSFORM , EAddChildFlags.RECALC_LOCAL_TRANSFORM }
 
enum  EntityEvent {
  EntityEvent.TOUCH , EntityEvent.INIT , EntityEvent.VISIBLE , EntityEvent.FRAME ,
  EntityEvent.POSTFRAME , EntityEvent.ANIMEVENT , EntityEvent.SIMULATE , EntityEvent.POSTSIMULATE ,
  EntityEvent.JOINTBREAK , EntityEvent.PHYSICSMOVE , EntityEvent.CONTACT , EntityEvent.PHYSICSACTIVE ,
  EntityEvent.FIXEDFRAME , EntityEvent.POSTFIXEDFRAME , EntityEvent.USER3 , EntityEvent.USER4 ,
  EntityEvent.USER5 , EntityEvent.DISABLED , EntityEvent.ALL
}
 Various entity events. More...
 
enum  EntityFlags {
  EntityFlags.VISIBLE , EntityFlags.TRACEABLE , EntityFlags.NO_LINK , EntityFlags.FEATURE ,
  EntityFlags.SET_RENDERED , EntityFlags.ACTIVE , EntityFlags.STATIC , EntityFlags.USER1 ,
  EntityFlags.USER2 , EntityFlags.USER3 , EntityFlags.USER4 , EntityFlags.USER5 ,
  EntityFlags.NO_TREE , EntityFlags.RELATIVE_Y , EntityFlags.EDITOR_ONLY , EntityFlags.DISABLED ,
  EntityFlags.PROXY , EntityFlags.UPDATE_LINK
}
 Various entity flags. More...
 
enum  EntityVisualizerType {
  EntityVisualizerType.EVT_NONE , EntityVisualizerType.EVT_NORMAL , EntityVisualizerType.EVT_SELECTED , EntityVisualizerType.EVT_SELECTED_AS_MAIN ,
  EntityVisualizerType.EVT_UNDER_CURSOR
}
 Game editor entity visualiser type. More...
 
enum  PointChangedSituation {
  PointChangedSituation.PCS_MOVED_FROM , PointChangedSituation.PCS_MOVED_TO , PointChangedSituation.PCS_ADDED , PointChangedSituation.PCS_REMOVED ,
  PointChangedSituation.PCS_BEFORE_DATA_CHANGED , PointChangedSituation.PCS_AFTER_DATA_CHANGED , PointChangedSituation.PCS_BEFORE_TANGENT_CHANGED , PointChangedSituation.PCS_AFTER_TANGENT_CHANGED
}
 

Detailed Description

Enumeration Type Documentation

◆ EAddChildFlags

Enumerator
NONE 
AUTO_TRANSFORM 

Turn on AutoTransform on hierarchy component if present.

RECALC_LOCAL_TRANSFORM 

Recalculate current world transform to local transform (child remains on the same world position)

◆ EntityEvent

Various entity events.

Enumerator
TOUCH 
INIT 
VISIBLE 
FRAME 
POSTFRAME 
ANIMEVENT 

Animation system event.

SIMULATE 
POSTSIMULATE 
JOINTBREAK 
PHYSICSMOVE 
CONTACT 
PHYSICSACTIVE 
FIXEDFRAME 
POSTFIXEDFRAME 
USER3 
USER4 
USER5 
DISABLED 

General event switch.

ALL 

Everything except general switch.

◆ EntityFlags

Various entity flags.

Enumerator
VISIBLE 

Entity is visible. Is rendered if there is some attached object and event EV_VISIBLE is invoked, when event mask is set.

TRACEABLE 

Entity can be detected by various trace methods.

NO_LINK 

Never link this entity into the scene.

FEATURE 

Scene rendering hint for dominant objects that are not culled by standard way.

SET_RENDERED 

You can check whether the entity has been rendered by enf::Entity::IsRendered()

ACTIVE 

Tells that this entity has to be actively updated by engine.

STATIC 

Tells that this entity will represent mostly static object, so we can use more precise but slower methods for scene-tree linking.

\ Also it tells to scene tree that he can count with this entity as tree-split hint.

USER1 

Flags for custom usage and filterings.

USER2 
USER3 
USER4 
USER5 
NO_TREE 

Do not include this entity into BSP tree building, because it's too huge, or off scene (like env-cube probes)

RELATIVE_Y 

The Y coordinate stored in.

EDITOR_ONLY 

Do not spawn this entity in game app.

DISABLED 

Do not spawn this entity anywhere.

PROXY 

Slave child entity, that is linked into scene tree just by its parent. Usually some small props/parts of more complex entity.

UPDATE_LINK 

Set when entity has changed position, orientation or just have to relink its position in scene tree.

◆ EntityVisualizerType

Game editor entity visualiser type.

Enumerator
EVT_NONE 

no visualizer

EVT_NORMAL 

normal visualizer

EVT_SELECTED 

selected entity visualiser (but no as main)

EVT_SELECTED_AS_MAIN 

selected as main entity visualiser

EVT_UNDER_CURSOR 

under cursor entity visualiser

◆ PointChangedSituation

Enumerator
PCS_MOVED_FROM 
PCS_MOVED_TO 
PCS_ADDED 
PCS_REMOVED 
PCS_BEFORE_DATA_CHANGED 
PCS_AFTER_DATA_CHANGED 
PCS_BEFORE_TANGENT_CHANGED 
PCS_AFTER_TANGENT_CHANGED