Enfusion Script API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
RplExample3System Interface Reference
Inheritance diagram for RplExample3System:
[legend]

Public Member Functions

override void OnPostInit (IEntity owner)
 Event called after init when all components are initialized.
 
override void EOnInit (IEntity owner)
 Event after entity is allocated and initialized.
 
RplExample3Controller NewController (RplIdentity identity)
 
void DeleteController (RplIdentity identity)
 
void ChangeColor (int idx)
 
- Public Member Functions inherited from ScriptComponent
proto external GenericEntity GetOwner ()
 Get owner entity.
 
- Public Member Functions inherited from GenericComponent
proto external EntityComponentPrefabData GetComponentData (notnull IEntity ent)
 Gets GenericComponentClass descendant instance with the prefab data.
 
proto external BaseContainer GetComponentSource (notnull IEntity ent)
 Gets config container with the prefab data.
 
proto void Rpc (func method, void p0=NULL, void p1=NULL, void p2=NULL, void p3=NULL, void p4=NULL, void p5=NULL, void p6=NULL, void p7=NULL)
 Attempts to run a remote procedure call (RPC) of this instance with parameters specified in method RplRpc attribute.
 
proto external int GetEventMask ()
 Gets current eventmask of the component.
 
proto external int SetEventMask (notnull IEntity owner, int mask)
 Sets eventmask.
 
proto external int ClearEventMask (notnull IEntity owner, int mask)
 Clears bitmask.
 
proto external GenericComponent FindComponent (TypeName typeName)
 Finds first occurance of the coresponding component.
 
proto external int FindComponents (TypeName typeName, notnull array< GenericComponent > outComponents)
 Finds all occurances of the coresponding component.
 
proto external void Activate (IEntity owner)
 Activate component and calls EOnActivate().
 
proto external void Deactivate (IEntity owner)
 Deactivate component and calls EOnDectivate().
 
proto external bool IsActive ()
 Returns activity state.
 
proto external void OnTransformReset (bool isCorrection=false, vector newVelocity=vector.Zero)
 Notifies the component that a transformation of the owner entity has been discontinuously changed.
 
void _WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)
 Editor changed entity transformation matrix source. Do not call editor API here!
 
void _WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)
 Called always after entity creation. It's purpose is to prepare entity for editing. Do not edit anything through editor API here because it's too early for undoable actions! Use plain BaseContainer API for changes through src parameter if needed!
 
bool _WB_CanDelete (IEntity owner, IEntitySource src)
 Editor needs to know if this entity can be deleted. Do not call editor API here!
 
bool _WB_CanRename (IEntity owner, IEntitySource src)
 Editor needs to know if this entity can be renamed. Do not call editor API here!
 
bool _WB_CanCopy (IEntity owner, IEntitySource src)
 Editor needs to know if this entity can be copied. Do not call editor API here!
 
bool _WB_CanSelect (IEntity owner, IEntitySource src)
 Editor needs to know whether this entity can be selected in scene window or not.
 
void _WB_GetBoundBox (IEntity owner, inout vector min, inout vector max, IEntitySource src)
 Editor needs to know a bound box of entity (For ray-casting, visualizers etc.). You can return any custom size you need. Do not call editor API here!
 
void _WB_SetExtraVisualiser (IEntity owner, EntityVisualizerType type, IEntitySource src)
 If entity needs to have a special visualizer instead of default one, here is the place where you can implement it. Do not call editor API here!
 
array< ref WB_UIMenuItem_WB_GetContextMenuItems (IEntity owner)
 An opportunity to append items into editor's "Component" context menu. Do not call editor API here!
 
bool _WB_OnPhysSimulPlacementBegin (IEntity owner, IEntitySource src)
 Does this entity support editing transformation using physics simulation? Do not call editor API here!
 
bool _WB_EnablePhysics (IEntity owner, IEntitySource src, bool physics)
 Prepare to edit transformation using physics simulation. Return previous status. Do not call editor API here!
 
bool _WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
 Any property value has been changed. You can use editor API here and do some additional edit actions which will be part of the same "key changed" action.
 
void _WB_AfterWorldUpdate (IEntity owner, float timeSlice)
 Called after updating world in Workbench. The entity must be selected. You can use editor API here and do some edit actions if needed.
 
void _WB_OnContextMenu (IEntity owner, int id)
 User has chosen any of your menu item from editor's "Component" menu which you have recently provided in WB_GetContextMenuItems(). You can use editor API here and do some edit actions.
 
void _WB_OnKeyDown (IEntity owner, int keyCode)
 User pressed a key and this entity is main member of entity selection. You can use editor API here and do some edit actions which will be undoable.
 
void _WB_OnCreate (IEntity owner, IEntitySource src)
 Called after entity gets created in map during editing or when deleted entity gets restored after undo action. This event isn't called by loading map!!! If you need an event that is being called after every entity creation then use WB_OnInit instead it. You can use editor API here and do some additional edit actions which will be part of the same "create entity" action.
 
void _WB_OnParentChange (IEntity owner, IEntitySource src, IEntitySource prevParentSrc)
 Parent entity has been changed ( it's available through src->GetParent() ). prevParentSrc is a pointer to a previous parent (if any)
 
void _WB_OnDelete (IEntity owner, IEntitySource src)
 Entity is going to be deleted. You can use editor API here and do some additional edit actions which will be part of the same "entity delete" action.
 
void _WB_OnRename (IEntity owner, IEntitySource src, string oldName)
 Entity has been renamed. You can use editor API here and do some additional edit actions which will be part of the same "entity rename" action.
 
array< ref ParamEnum_WB_GetUserEnums (string varName, IEntity owner, IEntityComponentSource src)
 Possibility to get variable value choices dynamically.
 

Public Attributes

ref RplExample3SessionListener m_SessionListener = new RplExample3SessionListener(this)
 
ref map< RplIdentity, RplExample3Controllerm_Controllers = new map<RplIdentity, RplExample3Controller>()
 
ref array< RplExample3ComponentColorAnimm_Spheres = new array<RplExample3ComponentColorAnim>()
 

Static Public Attributes

static const ResourceName s_ControllerPrefab = "{65B426E2CD4049C3}kroslakmar/RplExampleController.et"
 
static const ResourceName s_SpherePrefab = "{1AD0012447ACCE3F}kroslakmar/RplExampleShape.et"
 

Additional Inherited Members

- Static Public Member Functions inherited from GenericComponent
static bool Preload (IEntityComponentSource src)
 
- Protected Member Functions inherited from ScriptComponent
bool RplLoad (ScriptBitReader reader)
 Called when Item is initialized from replication stream.
 
bool RplSave (ScriptBitWriter writer)
 Called when Item is getting replicated from Master to Slave connection.
 
void EOnTouch (IEntity owner, IEntity other, int touchTypesMask)
 Event when touched by other entity.
 
void EOnInit (IEntity owner)
 Event after entity is allocated and initialized.
 
void EOnVisible (IEntity owner, int frameNumber)
 Event when we are visible.
 
void EOnFrame (IEntity owner, float timeSlice)
 Event every frame.
 
void EOnPostFrame (IEntity owner, float timeSlice)
 Event after physics update.
 
void EOnAnimEvent (IEntity owner, int type, int slot)
 Event from animation system.
 
void EOnSimulate (IEntity owner, float timeSlice)
 Event before every physics fixed step (can be multiple calls per engine update)
 
void EOnPostSimulate (IEntity owner, float timeSlice)
 Event after every physics fixed step (can be multiple calls per engine update)
 
void EOnJointBreak (IEntity owner, IEntity other)
 Event when joint attached to RigidBody of this entity is broken.
 
void EOnPhysicsMove (IEntity owner)
 Event when physics engine has moved with this Entity.
 
void EOnContact (IEntity owner, IEntity other, Contact contact)
 Event when physics engine registered contact with other RigidBody.
 
void EOnPhysicsActive (IEntity owner, bool activeState)
 Event when a RigidBody active state is changed between consecutive fixed steps.
 
void EOnDiag (IEntity owner, float timeSlice)
 Event every frame after EOnFrame, when "Entity diag" is enabled from the debug menu.
 
void EOnFixedFrame (IEntity owner, float timeSlice)
 Event every fixed frame.
 
void EOnPostFixedFrame (IEntity owner, float timeSlice)
 Event after physics update on every fixed frame.
 
void EOnActivate (IEntity owner)
 Event when component is activated.
 
void EOnDeactivate (IEntity owner)
 Event when component is deactivated.
 
void OnPostInit (IEntity owner)
 Event called after init when all components are initialized.
 
void OnDelete (IEntity owner)
 Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game::DeleteScriptComponent).
 
void OnAddedToParent (IEntity child, IEntity parent)
 Called on child entity when it is added into hierarchy.
 
void OnRemovedFromParent (IEntity child, IEntity parent)
 Called on child entity when it is removed from hierarchy.
 
void OnChildAdded (IEntity parent, IEntity child)
 Called on parent entity when child entity is added into hierarchy.
 
void OnChildRemoved (IEntity parent, IEntity child)
 Called on parent entity when child entity is removed from hierarchy.
 
- Protected Member Functions inherited from GenericComponent
proto external void ConnectToDiagSystem (IEntity owner)
 
proto external void DisconnectFromDiagSystem (IEntity owner)
 
void OnTransformResetImpl (TransformResetParams params)
 Script-side implementation of OnTransformReset.
 

Member Function Documentation

◆ ChangeColor()

void RplExample3System.ChangeColor ( int  idx)

◆ DeleteController()

void RplExample3System.DeleteController ( RplIdentity  identity)

◆ EOnInit()

override void RplExample3System.EOnInit ( IEntity  owner)

Event after entity is allocated and initialized.

Parameters
ownerThe owner entity

Implements ScriptComponent.

◆ NewController()

RplExample3Controller RplExample3System.NewController ( RplIdentity  identity)

◆ OnPostInit()

override void RplExample3System.OnPostInit ( IEntity  owner)

Event called after init when all components are initialized.

Parameters
ownerEntity into which component is added

Implements ScriptComponent.

Member Data Documentation

◆ m_Controllers

ref map<RplIdentity, RplExample3Controller> RplExample3System.m_Controllers = new map<RplIdentity, RplExample3Controller>()

◆ m_SessionListener

ref RplExample3SessionListener RplExample3System.m_SessionListener = new RplExample3SessionListener(this)

◆ m_Spheres

ref array<RplExample3ComponentColorAnim> RplExample3System.m_Spheres = new array<RplExample3ComponentColorAnim>()

◆ s_ControllerPrefab

const ResourceName RplExample3System.s_ControllerPrefab = "{65B426E2CD4049C3}kroslakmar/RplExampleController.et"
static

◆ s_SpherePrefab

const ResourceName RplExample3System.s_SpherePrefab = "{1AD0012447ACCE3F}kroslakmar/RplExampleShape.et"
static

The documentation for this interface was generated from the following file: