Inheritance diagram for GenericEntity:

Protected Member Functions
bool	RplLoad (ScriptBitReader reader)
bool	RplSave (ScriptBitWriter writer)
proto external void	Activate ()
proto external void	Deactivate ()
proto external void	Show (bool show)
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)
proto external WorldEditorAPI	_WB_GetEditorAPI ()
	This returns world editor API, which is safe to use from editor events bellow.
void	ConnectToDiagSystem ()
void	DisconnectFromDiagSystem ()
proto external void	OnTransformReset (bool isCorrection=false, vector newVelocity=vector.Zero)
void	EOnDiag (IEntity owner, float timeSlice)
void	EOnActivate (IEntity owner)
void	EOnDeactivate (IEntity owner)
event IEntity	_WB_GetEditableOwner ()
	Editor needs to know if there is any entity which manages this one and is editable.
event void	_WB_MakeVisible (IEntitySource src, bool visible)
	Editor needs to have entity visible or not. Do not call editor API here!
event void	_WB_SetTransform (inout vector mat[4], IEntitySource src)
	Editor changed transformation matrix source. This is the place to apply it on entity. Do not call editor API here!
event void	_WB_OnInit (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!
event bool	_WB_CanDelete (IEntitySource src)
	Editor needs to know if this entity can to be deleted. Do not call editor API here!
event bool	_WB_CanRename (IEntitySource src)
	Editor needs to know if this entity can to be renamed. Do not call editor API here!
event bool	_WB_CanCopy (IEntitySource src)
	Editor needs to know if this entity can be copied. Do not call editor API here!
event bool	_WB_CanSelect (IEntitySource src)
	Editor needs to know whether this entity can be selected in scene window or not.
event bool	_WB_IsTraceable (IEntitySource src)
	Editor needs to know whether this entity is traceable at selecting entities in scene.
event int	_WB_GetAnchorCount (IEntitySource src)
	Returns how many anchor points does this entity have at this time.
event void	_WB_GetAnchor (inout vector position, IEntitySource src, int index)
	Fills position of anchor at index index to anchorPosition.
event void	_WB_OnAnchorSnapped (IEntitySource thisSrc, int thisAnchor, IEntitySource otherSrc, int otherAnchor, bool isReceiver)
event bool	_WB_CanAnchorSnap (IEntitySource thisSrc, int thisAnchor, IEntitySource otherSrc, int otherAnchor, bool isReceiver)
event void	_WB_GetBoundBox (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!
event bool	_WB_ShouldShowBoundBox (IEntitySource src)
	Returns true if bound box should be visible when entity is hovered/selected in WB.
event void	_WB_SetExtraVisualiser (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!
event array< ref WB_UIMenuItem >	_WB_GetContextMenuItems ()
	An opportunity to append items into editor's "Entity" context menu. Do not call editor API here!
event bool	_WB_OnPhysSimulPlacementBegin (IEntitySource src)
	Does this entity support editing transformation using physics simulation? Do not call editor API here!
event bool	_WB_EnablePhysics (IEntitySource src, bool physics)
	Prepare to edit transformation using physics simulation. Return previous status. Do not call editor API here!
event array< ref ParamEnum >	_WB_GetUserEnums (string varName, IEntitySource src)
	Possibility to get variable value choices dynamically. Do not call editor API here!
event bool	_WB_OnKeyChanged (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.
event bool	_WB_GetKeySpaceMatrixWorld (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent, out vector transformSpaceWorld[4])
	Some "coords" or "angles" vector property is being to be edited. Entity can provide a world matrix which represents their local space and which is needed by editor to edit the key by a gizmo.
event void	_WB_AfterWorldUpdate (float timeSlice)
	Called after updating world in Workbench. The entity must be visible in frustum, selected or named. You can use editor API here and do some edit actions if needed.
event int	_WB_GetAfterWorldUpdateSpecs (IEntitySource src)
	Called after _WB_OnInit or also later when editor needs to know whether _WB_AfterWorldUpdate needs to be called and when. Return value can be either 0 (event will not be called at all) or any combination of EEntityFrameUpdateSpecs. Avoid CALL_ALWAYS flag whenever possible to prevent performance issues.
event void	_WB_OnContextMenu (int id)
	User has chosen any of your menu item from editor's "Entity" menu which you have recently provided in WB_GetContextMenuItems(). You can use editor API here and do some edit actions.
event void	_WB_OnKeyDown (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.
event void	_WB_OnCreate (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.
event void	_WB_OnParentChange (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).
event void	_WB_OnDelete (IEntitySource src)
	This 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.
event void	_WB_OnRename (IEntitySource src, string oldName)
	This 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.
void	OnTransformResetImpl (TransformResetParams params)
bool	RplLoad (ScriptBitReader reader)
bool	RplSave (ScriptBitWriter writer)
proto external void	Activate ()
proto external void	Deactivate ()
proto external void	Show (bool show)
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)
proto external WorldEditorAPI	_WB_GetEditorAPI ()
	This returns world editor API, which is safe to use from editor events bellow.
void	ConnectToDiagSystem ()
void	DisconnectFromDiagSystem ()
proto external void	OnTransformReset (bool isCorrection=false, vector newVelocity=vector.Zero)
void	EOnDiag (IEntity owner, float timeSlice)
void	EOnActivate (IEntity owner)
void	EOnDeactivate (IEntity owner)
event IEntity	_WB_GetEditableOwner ()
	Editor needs to know if there is any entity which manages this one and is editable.
event void	_WB_MakeVisible (IEntitySource src, bool visible)
	Editor needs to have entity visible or not. Do not call editor API here!
event void	_WB_SetTransform (inout vector mat[4], IEntitySource src)
	Editor changed transformation matrix source. This is the place to apply it on entity. Do not call editor API here!
event void	_WB_OnInit (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!
event bool	_WB_CanDelete (IEntitySource src)
	Editor needs to know if this entity can to be deleted. Do not call editor API here!
event bool	_WB_CanRename (IEntitySource src)
	Editor needs to know if this entity can to be renamed. Do not call editor API here!
event bool	_WB_CanCopy (IEntitySource src)
	Editor needs to know if this entity can be copied. Do not call editor API here!
event bool	_WB_CanSelect (IEntitySource src)
	Editor needs to know whether this entity can be selected in scene window or not.
event bool	_WB_IsTraceable (IEntitySource src)
	Editor needs to know whether this entity is traceable at selecting entities in scene.
event int	_WB_GetAnchorCount (IEntitySource src)
	Returns how many anchor points does this entity have at this time.
event void	_WB_GetAnchor (inout vector position, IEntitySource src, int index)
	Fills position of anchor at index index to anchorPosition.
event void	_WB_OnAnchorSnapped (IEntitySource thisSrc, int thisAnchor, IEntitySource otherSrc, int otherAnchor, bool isReceiver)
event bool	_WB_CanAnchorSnap (IEntitySource thisSrc, int thisAnchor, IEntitySource otherSrc, int otherAnchor, bool isReceiver)
event void	_WB_GetBoundBox (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!
event bool	_WB_ShouldShowBoundBox (IEntitySource src)
	Returns true if bound box should be visible when entity is hovered/selected in WB.
event void	_WB_SetExtraVisualiser (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!
event array< ref WB_UIMenuItem >	_WB_GetContextMenuItems ()
	An opportunity to append items into editor's "Entity" context menu. Do not call editor API here!
event bool	_WB_OnPhysSimulPlacementBegin (IEntitySource src)
	Does this entity support editing transformation using physics simulation? Do not call editor API here!
event bool	_WB_EnablePhysics (IEntitySource src, bool physics)
	Prepare to edit transformation using physics simulation. Return previous status. Do not call editor API here!
event array< ref ParamEnum >	_WB_GetUserEnums (string varName, IEntitySource src)
	Possibility to get variable value choices dynamically. Do not call editor API here!
event bool	_WB_OnKeyChanged (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.
event bool	_WB_GetKeySpaceMatrixWorld (BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent, out vector transformSpaceWorld[4])
	Some "coords" or "angles" vector property is being to be edited. Entity can provide a world matrix which represents their local space and which is needed by editor to edit the key by a gizmo.
event void	_WB_AfterWorldUpdate (float timeSlice)
	Called after updating world in Workbench. The entity must be visible in frustum, selected or named. You can use editor API here and do some edit actions if needed.
event int	_WB_GetAfterWorldUpdateSpecs (IEntitySource src)
	Called after _WB_OnInit or also later when editor needs to know whether _WB_AfterWorldUpdate needs to be called and when. Return value can be either 0 (event will not be called at all) or any combination of EEntityFrameUpdateSpecs. Avoid CALL_ALWAYS flag whenever possible to prevent performance issues.
event void	_WB_OnContextMenu (int id)
	User has chosen any of your menu item from editor's "Entity" menu which you have recently provided in WB_GetContextMenuItems(). You can use editor API here and do some edit actions.
event void	_WB_OnKeyDown (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.
event void	_WB_OnCreate (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.
event void	_WB_OnParentChange (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).
event void	_WB_OnDelete (IEntitySource src)
	This 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.
event void	_WB_OnRename (IEntitySource src, string oldName)
	This 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.
void	OnTransformResetImpl (TransformResetParams params)

Static Protected Member Functions
static event bool	Preload (IEntitySource src)
static proto void	GetMatrixFromSource (BaseWorld world, IEntitySource src, bool withScale, out vector mat[4])
static event bool	Preload (IEntitySource src)
static proto void	GetMatrixFromSource (BaseWorld world, IEntitySource src, bool withScale, out vector mat[4])

Detailed Description

Base entity class.

Definition at line 15 of file GenericEntity.c.

Member Function Documentation

◆ _WB_AfterWorldUpdate() [1/2]

event void GenericEntity::_WB_AfterWorldUpdate ( float timeSlice )

protected

Called after updating world in Workbench. The entity must be visible in frustum, selected or named. You can use editor API here and do some edit actions if needed.

◆ _WB_AfterWorldUpdate() [2/2]

event void GenericEntity::_WB_AfterWorldUpdate ( float timeSlice )

protected

Called after updating world in Workbench. The entity must be visible in frustum, selected or named. You can use editor API here and do some edit actions if needed.

◆ _WB_CanAnchorSnap() [1/2]

event bool GenericEntity::_WB_CanAnchorSnap	(	IEntitySource	thisSrc,
		int	thisAnchor,
		IEntitySource	otherSrc,
		int	otherAnchor,
		bool	isReceiver )

inlineprotected

See also: WB_OnAnchorSnapped

Returns: True if this entity agrees with the snap operation

Definition at line 126 of file GenericEntity.c.

◆ _WB_CanAnchorSnap() [2/2]

event bool GenericEntity::_WB_CanAnchorSnap	(	IEntitySource	thisSrc,
		int	thisAnchor,
		IEntitySource	otherSrc,
		int	otherAnchor,
		bool	isReceiver )

inlineprotected

See also: WB_OnAnchorSnapped

Returns: True if this entity agrees with the snap operation

Definition at line 126 of file GenericEntity.c.

◆ _WB_CanCopy() [1/2]

event bool GenericEntity::_WB_CanCopy ( IEntitySource src )

inlineprotected

Editor needs to know if this entity can be copied. Do not call editor API here!

Definition at line 108 of file GenericEntity.c.

◆ _WB_CanCopy() [2/2]

event bool GenericEntity::_WB_CanCopy ( IEntitySource src )

inlineprotected

Editor needs to know if this entity can be copied. Do not call editor API here!

Definition at line 108 of file GenericEntity.c.

◆ _WB_CanDelete() [1/2]

event bool GenericEntity::_WB_CanDelete ( IEntitySource src )

inlineprotected

Editor needs to know if this entity can to be deleted. Do not call editor API here!

Definition at line 104 of file GenericEntity.c.

◆ _WB_CanDelete() [2/2]

event bool GenericEntity::_WB_CanDelete ( IEntitySource src )

inlineprotected

Editor needs to know if this entity can to be deleted. Do not call editor API here!

Definition at line 104 of file GenericEntity.c.

◆ _WB_CanRename() [1/2]

event bool GenericEntity::_WB_CanRename ( IEntitySource src )

inlineprotected

Editor needs to know if this entity can to be renamed. Do not call editor API here!

Definition at line 106 of file GenericEntity.c.

◆ _WB_CanRename() [2/2]

event bool GenericEntity::_WB_CanRename ( IEntitySource src )

inlineprotected

Editor needs to know if this entity can to be renamed. Do not call editor API here!

Definition at line 106 of file GenericEntity.c.

◆ _WB_CanSelect() [1/2]

event bool GenericEntity::_WB_CanSelect ( IEntitySource src )

inlineprotected

Editor needs to know whether this entity can be selected in scene window or not.

Definition at line 110 of file GenericEntity.c.

◆ _WB_CanSelect() [2/2]

event bool GenericEntity::_WB_CanSelect ( IEntitySource src )

inlineprotected

Editor needs to know whether this entity can be selected in scene window or not.

Definition at line 110 of file GenericEntity.c.

◆ _WB_EnablePhysics() [1/2]

event bool GenericEntity::_WB_EnablePhysics	(	IEntitySource	src,
		bool	physics )

protected

Prepare to edit transformation using physics simulation. Return previous status. Do not call editor API here!

◆ _WB_EnablePhysics() [2/2]

event bool GenericEntity::_WB_EnablePhysics	(	IEntitySource	src,
		bool	physics )

protected

Prepare to edit transformation using physics simulation. Return previous status. Do not call editor API here!

◆ _WB_GetAfterWorldUpdateSpecs() [1/2]

event int GenericEntity::_WB_GetAfterWorldUpdateSpecs ( IEntitySource src )

protected

Called after _WB_OnInit or also later when editor needs to know whether _WB_AfterWorldUpdate needs to be called and when. Return value can be either 0 (event will not be called at all) or any combination of EEntityFrameUpdateSpecs. Avoid CALL_ALWAYS flag whenever possible to prevent performance issues.

◆ _WB_GetAfterWorldUpdateSpecs() [2/2]

event int GenericEntity::_WB_GetAfterWorldUpdateSpecs ( IEntitySource src )

protected

Called after _WB_OnInit or also later when editor needs to know whether _WB_AfterWorldUpdate needs to be called and when. Return value can be either 0 (event will not be called at all) or any combination of EEntityFrameUpdateSpecs. Avoid CALL_ALWAYS flag whenever possible to prevent performance issues.

◆ _WB_GetAnchor() [1/2]

event void GenericEntity::_WB_GetAnchor	(	inout vector	position,
		IEntitySource	src,
		int	index )

protected

Fills position of anchor at index index to anchorPosition.

◆ _WB_GetAnchor() [2/2]

event void GenericEntity::_WB_GetAnchor	(	inout vector	position,
		IEntitySource	src,
		int	index )

protected

Fills position of anchor at index index to anchorPosition.

◆ _WB_GetAnchorCount() [1/2]

event int GenericEntity::_WB_GetAnchorCount ( IEntitySource src )

protected

Returns how many anchor points does this entity have at this time.

◆ _WB_GetAnchorCount() [2/2]

event int GenericEntity::_WB_GetAnchorCount ( IEntitySource src )

protected

Returns how many anchor points does this entity have at this time.

◆ _WB_GetBoundBox() [1/2]

event void GenericEntity::_WB_GetBoundBox	(	inout vector	min,
		inout vector	max,
		IEntitySource	src )

protected

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!

◆ _WB_GetBoundBox() [2/2]

event void GenericEntity::_WB_GetBoundBox	(	inout vector	min,
		inout vector	max,
		IEntitySource	src )

protected

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!

◆ _WB_GetContextMenuItems() [1/2]

event array< ref WB_UIMenuItem > GenericEntity::_WB_GetContextMenuItems ( )

protected

An opportunity to append items into editor's "Entity" context menu. Do not call editor API here!

◆ _WB_GetContextMenuItems() [2/2]

event array< ref WB_UIMenuItem > GenericEntity::_WB_GetContextMenuItems ( )

protected

An opportunity to append items into editor's "Entity" context menu. Do not call editor API here!

◆ _WB_GetEditableOwner() [1/2]

event IEntity GenericEntity::_WB_GetEditableOwner ( )

protected

Editor needs to know if there is any entity which manages this one and is editable.

◆ _WB_GetEditableOwner() [2/2]

event IEntity GenericEntity::_WB_GetEditableOwner ( )

protected

Editor needs to know if there is any entity which manages this one and is editable.

◆ _WB_GetEditorAPI() [1/2]

proto external WorldEditorAPI GenericEntity::_WB_GetEditorAPI ( )

protected

This returns world editor API, which is safe to use from editor events bellow.

◆ _WB_GetEditorAPI() [2/2]

proto external WorldEditorAPI GenericEntity::_WB_GetEditorAPI ( )

protected

This returns world editor API, which is safe to use from editor events bellow.

◆ _WB_GetKeySpaceMatrixWorld() [1/2]

event bool GenericEntity::_WB_GetKeySpaceMatrixWorld	(	BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent,
		out vector	transformSpaceWorld[4] )

inlineprotected

Some "coords" or "angles" vector property is being to be edited. Entity can provide a world matrix which represents their local space and which is needed by editor to edit the key by a gizmo.

Definition at line 144 of file GenericEntity.c.

◆ _WB_GetKeySpaceMatrixWorld() [2/2]

event bool GenericEntity::_WB_GetKeySpaceMatrixWorld	(	BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent,
		out vector	transformSpaceWorld[4] )

inlineprotected

Some "coords" or "angles" vector property is being to be edited. Entity can provide a world matrix which represents their local space and which is needed by editor to edit the key by a gizmo.

Definition at line 144 of file GenericEntity.c.

◆ _WB_GetUserEnums() [1/2]

event array< ref ParamEnum > GenericEntity::_WB_GetUserEnums	(	string	varName,
		IEntitySource	src )

protected

Possibility to get variable value choices dynamically. Do not call editor API here!

◆ _WB_GetUserEnums() [2/2]

event array< ref ParamEnum > GenericEntity::_WB_GetUserEnums	(	string	varName,
		IEntitySource	src )

protected

Possibility to get variable value choices dynamically. Do not call editor API here!

◆ _WB_IsTraceable() [1/2]

event bool GenericEntity::_WB_IsTraceable ( IEntitySource src )

inlineprotected

Editor needs to know whether this entity is traceable at selecting entities in scene.

Definition at line 112 of file GenericEntity.c.

◆ _WB_IsTraceable() [2/2]

event bool GenericEntity::_WB_IsTraceable ( IEntitySource src )

inlineprotected

Editor needs to know whether this entity is traceable at selecting entities in scene.

Definition at line 112 of file GenericEntity.c.

◆ _WB_MakeVisible() [1/2]

event void GenericEntity::_WB_MakeVisible	(	IEntitySource	src,
		bool	visible )

protected

Editor needs to have entity visible or not. Do not call editor API here!

◆ _WB_MakeVisible() [2/2]

event void GenericEntity::_WB_MakeVisible	(	IEntitySource	src,
		bool	visible )

protected

Editor needs to have entity visible or not. Do not call editor API here!

◆ _WB_OnAnchorSnapped() [1/2]

event void GenericEntity::_WB_OnAnchorSnapped	(	IEntitySource	thisSrc,
		int	thisAnchor,
		IEntitySource	otherSrc,
		int	otherAnchor,
		bool	isReceiver )

protected

Called when two entities are snapped together

Parameters

isReceiver True if another entity snapped to this one, false otherwise.

◆ _WB_OnAnchorSnapped() [2/2]

event void GenericEntity::_WB_OnAnchorSnapped	(	IEntitySource	thisSrc,
		int	thisAnchor,
		IEntitySource	otherSrc,
		int	otherAnchor,
		bool	isReceiver )

protected

Called when two entities are snapped together

Parameters

isReceiver True if another entity snapped to this one, false otherwise.

◆ _WB_OnContextMenu() [1/2]

event void GenericEntity::_WB_OnContextMenu ( int id )

protected

User has chosen any of your menu item from editor's "Entity" menu which you have recently provided in WB_GetContextMenuItems(). You can use editor API here and do some edit actions.

◆ _WB_OnContextMenu() [2/2]

event void GenericEntity::_WB_OnContextMenu ( int id )

protected

User has chosen any of your menu item from editor's "Entity" menu which you have recently provided in WB_GetContextMenuItems(). You can use editor API here and do some edit actions.

◆ _WB_OnCreate() [1/2]

event void GenericEntity::_WB_OnCreate ( IEntitySource src )

protected

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.

◆ _WB_OnCreate() [2/2]

event void GenericEntity::_WB_OnCreate ( IEntitySource src )

protected

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.

◆ _WB_OnDelete() [1/2]

event void GenericEntity::_WB_OnDelete ( IEntitySource src )

protected

This 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.

◆ _WB_OnDelete() [2/2]

event void GenericEntity::_WB_OnDelete ( IEntitySource src )

protected

This 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.

◆ _WB_OnInit() [1/2]

event void GenericEntity::_WB_OnInit	(	inout vector	mat[4],
		IEntitySource	src )

protected

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!

◆ _WB_OnInit() [2/2]

event void GenericEntity::_WB_OnInit	(	inout vector	mat[4],
		IEntitySource	src )

protected

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!

◆ _WB_OnKeyChanged() [1/2]

event bool GenericEntity::_WB_OnKeyChanged	(	BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent )

protected

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.

◆ _WB_OnKeyChanged() [2/2]

event bool GenericEntity::_WB_OnKeyChanged	(	BaseContainer	src,
		string	key,
		BaseContainerList	ownerContainers,
		IEntity	parent )

protected

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.

◆ _WB_OnKeyDown() [1/2]

event void GenericEntity::_WB_OnKeyDown ( int keyCode )

protected

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.

◆ _WB_OnKeyDown() [2/2]

event void GenericEntity::_WB_OnKeyDown ( int keyCode )

protected

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.

◆ _WB_OnParentChange() [1/2]

event void GenericEntity::_WB_OnParentChange	(	IEntitySource	src,
		IEntitySource	prevParentSrc )

protected

Parent entity has been changed ( it's available through src->GetParent() ). prevParentSrc is a pointer to a previous parent (if any).

◆ _WB_OnParentChange() [2/2]

event void GenericEntity::_WB_OnParentChange	(	IEntitySource	src,
		IEntitySource	prevParentSrc )

protected

Parent entity has been changed ( it's available through src->GetParent() ). prevParentSrc is a pointer to a previous parent (if any).

◆ _WB_OnPhysSimulPlacementBegin() [1/2]

event bool GenericEntity::_WB_OnPhysSimulPlacementBegin ( IEntitySource src )

inlineprotected

Does this entity support editing transformation using physics simulation? Do not call editor API here!

Definition at line 136 of file GenericEntity.c.

◆ _WB_OnPhysSimulPlacementBegin() [2/2]

event bool GenericEntity::_WB_OnPhysSimulPlacementBegin ( IEntitySource src )

inlineprotected

Does this entity support editing transformation using physics simulation? Do not call editor API here!

Definition at line 136 of file GenericEntity.c.

◆ _WB_OnRename() [1/2]

event void GenericEntity::_WB_OnRename	(	IEntitySource	src,
		string	oldName )

protected

This 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.

◆ _WB_OnRename() [2/2]

event void GenericEntity::_WB_OnRename	(	IEntitySource	src,
		string	oldName )

protected

This 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.

◆ _WB_SetExtraVisualiser() [1/2]

event void GenericEntity::_WB_SetExtraVisualiser	(	EntityVisualizerType	type,
		IEntitySource	src )

protected

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!

◆ _WB_SetExtraVisualiser() [2/2]

event void GenericEntity::_WB_SetExtraVisualiser	(	EntityVisualizerType	type,
		IEntitySource	src )

protected

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!

◆ _WB_SetTransform() [1/2]

event void GenericEntity::_WB_SetTransform	(	inout vector	mat[4],
		IEntitySource	src )

protected

Editor changed transformation matrix source. This is the place to apply it on entity. Do not call editor API here!

◆ _WB_SetTransform() [2/2]

event void GenericEntity::_WB_SetTransform	(	inout vector	mat[4],
		IEntitySource	src )

protected

Editor changed transformation matrix source. This is the place to apply it on entity. Do not call editor API here!

◆ _WB_ShouldShowBoundBox() [1/2]

event bool GenericEntity::_WB_ShouldShowBoundBox ( IEntitySource src )

inlineprotected

Returns true if bound box should be visible when entity is hovered/selected in WB.

Definition at line 130 of file GenericEntity.c.

◆ _WB_ShouldShowBoundBox() [2/2]

event bool GenericEntity::_WB_ShouldShowBoundBox ( IEntitySource src )

inlineprotected

Returns true if bound box should be visible when entity is hovered/selected in WB.

Definition at line 130 of file GenericEntity.c.

◆ Activate() [1/2]

proto external void GenericEntity::Activate ( )

protected

Activate entity events. Will also activate all components of the entity.

◆ Activate() [2/2]

proto external void GenericEntity::Activate ( )

protected

Activate entity events. Will also activate all components of the entity.

◆ ConnectToDiagSystem() [1/2]

void GenericEntity::ConnectToDiagSystem ( )

protected

◆ ConnectToDiagSystem() [2/2]

void GenericEntity::ConnectToDiagSystem ( )

protected

◆ Deactivate() [1/2]

proto external void GenericEntity::Deactivate ( )

protected

Deactivate entity events. Will also deactivate all components of the entity.

◆ Deactivate() [2/2]

proto external void GenericEntity::Deactivate ( )

protected

Deactivate entity events. Will also deactivate all components of the entity.

◆ DisconnectFromDiagSystem() [1/2]

void GenericEntity::DisconnectFromDiagSystem ( )

protected

◆ DisconnectFromDiagSystem() [2/2]

void GenericEntity::DisconnectFromDiagSystem ( )

protected

◆ EOnActivate() [1/2]

void GenericEntity::EOnActivate ( IEntity owner )

protected

Event when entity is activated.

◆ EOnActivate() [2/2]

void GenericEntity::EOnActivate ( IEntity owner )

protected

Event when entity is activated.

◆ EOnDeactivate() [1/2]

void GenericEntity::EOnDeactivate ( IEntity owner )

protected

Event when entity is deactivated.

◆ EOnDeactivate() [2/2]

void GenericEntity::EOnDeactivate ( IEntity owner )

protected

Event when entity is deactivated.

◆ EOnDiag() [1/2]

void GenericEntity::EOnDiag	(	IEntity	owner,
		float	timeSlice )

protected

◆ EOnDiag() [2/2]

void GenericEntity::EOnDiag	(	IEntity	owner,
		float	timeSlice )

protected

◆ GetMatrixFromSource() [1/2]

proto void GenericEntity::GetMatrixFromSource	(	BaseWorld	world,
		IEntitySource	src,
		bool	withScale,
		out vector	mat[4] )

staticprotected

◆ GetMatrixFromSource() [2/2]

proto void GenericEntity::GetMatrixFromSource	(	BaseWorld	world,
		IEntitySource	src,
		bool	withScale,
		out vector	mat[4] )

staticprotected

◆ OnTransformReset() [1/2]

proto external void GenericEntity::OnTransformReset	(	bool	isCorrection = false,
		vector	newVelocity = vector.Zero )

protected

Notifies the entity that its transformation has been discontinuously changed.

Should be called after any transformation discontinuity (right after updating the transform) e.g. by teleportation or desync-correction code so the entity can react appropriately.

The default implementation handles Particles (if present on the entity) and calls OnTransformReset on all of the entity's GenericComponent instances and child GenericEntity instances with auto-transform enabled (i.e. it handles the whole entity and component hierarchy by recursion).

The default behavior may be changed in inherited entities by overriding OnTransformResetImpl.

Parameters

isCorrection	[optional] Hint that the transform was reset due to its correction (e.g. by net-code), i.e. not a placement/teleport
newVelocity	[optional] Initial velocity of the entity after the transform reset

◆ OnTransformReset() [2/2]

proto external void GenericEntity::OnTransformReset	(	bool	isCorrection = false,
		vector	newVelocity = vector.Zero )

protected

Notifies the entity that its transformation has been discontinuously changed.

Should be called after any transformation discontinuity (right after updating the transform) e.g. by teleportation or desync-correction code so the entity can react appropriately.

The default implementation handles Particles (if present on the entity) and calls OnTransformReset on all of the entity's GenericComponent instances and child GenericEntity instances with auto-transform enabled (i.e. it handles the whole entity and component hierarchy by recursion).

The default behavior may be changed in inherited entities by overriding OnTransformResetImpl.

Parameters

isCorrection	[optional] Hint that the transform was reset due to its correction (e.g. by net-code), i.e. not a placement/teleport
newVelocity	[optional] Initial velocity of the entity after the transform reset

◆ OnTransformResetImpl() [1/2]

void GenericEntity::OnTransformResetImpl ( TransformResetParams params )

inlineprotected

Script-side implementation of OnTransformReset.

The default implementation handles Particles (if present on the entity) and calls OnTransformReset on all of the entity's GenericComponent instances and child GenericEntity instances (i.e. it handles the whole entity and component hierarchy by recursion).

Can be overridden to alter the default behavior. Usually, you'll want to call the base implementation somewhere in the override to preserve the recursion.

Parameters

params See the TransformResetParams documentation.

Definition at line 173 of file GenericEntity.c.

◆ OnTransformResetImpl() [2/2]

void GenericEntity::OnTransformResetImpl ( TransformResetParams params )

inlineprotected

Script-side implementation of OnTransformReset.

The default implementation handles Particles (if present on the entity) and calls OnTransformReset on all of the entity's GenericComponent instances and child GenericEntity instances (i.e. it handles the whole entity and component hierarchy by recursion).

Can be overridden to alter the default behavior. Usually, you'll want to call the base implementation somewhere in the override to preserve the recursion.

Parameters

params See the TransformResetParams documentation.

Definition at line 173 of file GenericEntity.c.

◆ Preload() [1/2]

event bool GenericEntity::Preload ( IEntitySource src )

staticprotected

◆ Preload() [2/2]

event bool GenericEntity::Preload ( IEntitySource src )

staticprotected

◆ Rpc() [1/2]

void GenericEntity::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 )

protected

Attempts to run a remote procedure call (RPC) of this instance with parameters specified in method RplRpc attribute.

Parameters

method Member function to be invoked as an RPC.

◆ Rpc() [2/2]

void GenericEntity::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 )

protected

Attempts to run a remote procedure call (RPC) of this instance with parameters specified in method RplRpc attribute.

Parameters

method Member function to be invoked as an RPC.

◆ RplLoad() [1/2]

bool GenericEntity::RplLoad ( ScriptBitReader reader )

protected

Called when Item is initialized from replication stream. Carries the data from Master.

◆ RplLoad() [2/2]

bool GenericEntity::RplLoad ( ScriptBitReader reader )

protected

Called when Item is initialized from replication stream. Carries the data from Master.

◆ RplSave() [1/2]

bool GenericEntity::RplSave ( ScriptBitWriter writer )

protected

Called when Item is getting replicated from Master to Slave connection. The data will be delivered to Slave using RplInit method.

◆ RplSave() [2/2]

bool GenericEntity::RplSave ( ScriptBitWriter writer )

protected

Called when Item is getting replicated from Master to Slave connection. The data will be delivered to Slave using RplInit method.

◆ Show() [1/2]

proto external void GenericEntity::Show ( bool show )

protected

◆ Show() [2/2]

proto external void GenericEntity::Show ( bool show )

protected

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

scripts/GameLib/generated/Entities/GenericEntity.c

Protected Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ _WB_AfterWorldUpdate() [1/2]

◆ _WB_AfterWorldUpdate() [2/2]

◆ _WB_CanAnchorSnap() [1/2]

◆ _WB_CanAnchorSnap() [2/2]

◆ _WB_CanCopy() [1/2]

◆ _WB_CanCopy() [2/2]

◆ _WB_CanDelete() [1/2]

◆ _WB_CanDelete() [2/2]

◆ _WB_CanRename() [1/2]

◆ _WB_CanRename() [2/2]

◆ _WB_CanSelect() [1/2]

◆ _WB_CanSelect() [2/2]

◆ _WB_EnablePhysics() [1/2]

◆ _WB_EnablePhysics() [2/2]

◆ _WB_GetAfterWorldUpdateSpecs() [1/2]

◆ _WB_GetAfterWorldUpdateSpecs() [2/2]

◆ _WB_GetAnchor() [1/2]

◆ _WB_GetAnchor() [2/2]

◆ _WB_GetAnchorCount() [1/2]

◆ _WB_GetAnchorCount() [2/2]

◆ _WB_GetBoundBox() [1/2]

◆ _WB_GetBoundBox() [2/2]

◆ _WB_GetContextMenuItems() [1/2]

◆ _WB_GetContextMenuItems() [2/2]

◆ _WB_GetEditableOwner() [1/2]

◆ _WB_GetEditableOwner() [2/2]

◆ _WB_GetEditorAPI() [1/2]

◆ _WB_GetEditorAPI() [2/2]

◆ _WB_GetKeySpaceMatrixWorld() [1/2]

◆ _WB_GetKeySpaceMatrixWorld() [2/2]

◆ _WB_GetUserEnums() [1/2]

◆ _WB_GetUserEnums() [2/2]

◆ _WB_IsTraceable() [1/2]

◆ _WB_IsTraceable() [2/2]

◆ _WB_MakeVisible() [1/2]

◆ _WB_MakeVisible() [2/2]

◆ _WB_OnAnchorSnapped() [1/2]

◆ _WB_OnAnchorSnapped() [2/2]

◆ _WB_OnContextMenu() [1/2]

◆ _WB_OnContextMenu() [2/2]

◆ _WB_OnCreate() [1/2]

◆ _WB_OnCreate() [2/2]

◆ _WB_OnDelete() [1/2]

◆ _WB_OnDelete() [2/2]

◆ _WB_OnInit() [1/2]

◆ _WB_OnInit() [2/2]

◆ _WB_OnKeyChanged() [1/2]

◆ _WB_OnKeyChanged() [2/2]

◆ _WB_OnKeyDown() [1/2]

◆ _WB_OnKeyDown() [2/2]

◆ _WB_OnParentChange() [1/2]

◆ _WB_OnParentChange() [2/2]

◆ _WB_OnPhysSimulPlacementBegin() [1/2]

◆ _WB_OnPhysSimulPlacementBegin() [2/2]

◆ _WB_OnRename() [1/2]

◆ _WB_OnRename() [2/2]

◆ _WB_SetExtraVisualiser() [1/2]

◆ _WB_SetExtraVisualiser() [2/2]

◆ _WB_SetTransform() [1/2]

◆ _WB_SetTransform() [2/2]

◆ _WB_ShouldShowBoundBox() [1/2]

◆ _WB_ShouldShowBoundBox() [2/2]

◆ Activate() [1/2]

◆ Activate() [2/2]

◆ ConnectToDiagSystem() [1/2]

◆ ConnectToDiagSystem() [2/2]

◆ Deactivate() [1/2]

◆ Deactivate() [2/2]

◆ DisconnectFromDiagSystem() [1/2]

◆ DisconnectFromDiagSystem() [2/2]

◆ EOnActivate() [1/2]

◆ EOnActivate() [2/2]

◆ EOnDeactivate() [1/2]

◆ EOnDeactivate() [2/2]

◆ EOnDiag() [1/2]

◆ EOnDiag() [2/2]