Inheritance diagram for GenericComponent:

Protected Member Functions
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 int	GetEventMask ()
proto external int	SetEventMask (notnull IEntity owner, int mask)
proto external int	ClearEventMask (notnull IEntity owner, int mask)
proto external GenericComponent	FindComponent (typename typeName)
proto external int	FindComponents (typename typeName, notnull array< GenericComponent > outComponents)
proto external void	Activate (IEntity owner)
proto external void	Deactivate (IEntity owner)
proto external bool	IsActive ()
void	ConnectToDiagSystem (IEntity owner)
void	DisconnectFromDiagSystem (IEntity owner)
proto external void	OnTransformReset (bool isCorrection=false, vector newVelocity=vector.Zero)
event void	_WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)
	Editor changed entity transformation matrix source. Do not call editor API here!
event 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!
event bool	_WB_CanDelete (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be deleted. Do not call editor API here!
event bool	_WB_CanRename (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be renamed. Do not call editor API here!
event bool	_WB_CanCopy (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be copied. Do not call editor API here!
event bool	_WB_CanSelect (IEntity owner, IEntitySource src)
	Editor needs to know whether this entity can be selected in scene window or not.
event bool	_WB_IsTraceable (IEntity owner, IEntitySource src)
	Editor needs to know whether this entity is traceable at selecting entities in scene.
event 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!
event 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!
event bool	_WB_OnPhysSimulPlacementBegin (IEntity owner, IEntitySource src)
	Does this entity support editing transformation using physics simulation? Do not call editor API here!
event 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!
event 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.
event bool	_WB_GetKeySpaceMatrixWorld (IEntity owner, 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 (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.
event int	_WB_GetAfterWorldUpdateSpecs (IEntity owner, 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 (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.
event 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.
event 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.
event 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).
event 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.
event 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.
event array< ref ParamEnum >	_WB_GetUserEnums (string varName, IEntity owner, IEntityComponentSource src)
	Possibility to get variable value choices dynamically.
void	OnTransformResetImpl (TransformResetParams params)
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 int	GetEventMask ()
proto external int	SetEventMask (notnull IEntity owner, int mask)
proto external int	ClearEventMask (notnull IEntity owner, int mask)
proto external GenericComponent	FindComponent (typename typeName)
proto external int	FindComponents (typename typeName, notnull array< GenericComponent > outComponents)
proto external void	Activate (IEntity owner)
proto external void	Deactivate (IEntity owner)
proto external bool	IsActive ()
void	ConnectToDiagSystem (IEntity owner)
void	DisconnectFromDiagSystem (IEntity owner)
proto external void	OnTransformReset (bool isCorrection=false, vector newVelocity=vector.Zero)
event void	_WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)
	Editor changed entity transformation matrix source. Do not call editor API here!
event 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!
event bool	_WB_CanDelete (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be deleted. Do not call editor API here!
event bool	_WB_CanRename (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be renamed. Do not call editor API here!
event bool	_WB_CanCopy (IEntity owner, IEntitySource src)
	Editor needs to know if this entity can be copied. Do not call editor API here!
event bool	_WB_CanSelect (IEntity owner, IEntitySource src)
	Editor needs to know whether this entity can be selected in scene window or not.
event bool	_WB_IsTraceable (IEntity owner, IEntitySource src)
	Editor needs to know whether this entity is traceable at selecting entities in scene.
event 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!
event 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!
event bool	_WB_OnPhysSimulPlacementBegin (IEntity owner, IEntitySource src)
	Does this entity support editing transformation using physics simulation? Do not call editor API here!
event 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!
event 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.
event bool	_WB_GetKeySpaceMatrixWorld (IEntity owner, 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 (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.
event int	_WB_GetAfterWorldUpdateSpecs (IEntity owner, 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 (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.
event 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.
event 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.
event 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).
event 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.
event 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.
event array< ref ParamEnum >	_WB_GetUserEnums (string varName, IEntity owner, IEntityComponentSource src)
	Possibility to get variable value choices dynamically.
void	OnTransformResetImpl (TransformResetParams params)

Detailed Description

Definition at line 12 of file GenericComponent.c.

Member Function Documentation

◆ _WB_AfterWorldUpdate() [1/2]

event void GenericComponent::_WB_AfterWorldUpdate	(	IEntity	owner,
		float	timeSlice )

protected

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

◆ _WB_AfterWorldUpdate() [2/2]

event void GenericComponent::_WB_AfterWorldUpdate	(	IEntity	owner,
		float	timeSlice )

protected

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

◆ _WB_CanCopy() [1/2]

event bool GenericComponent::_WB_CanCopy	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 114 of file GenericComponent.c.

◆ _WB_CanCopy() [2/2]

event bool GenericComponent::_WB_CanCopy	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 114 of file GenericComponent.c.

◆ _WB_CanDelete() [1/2]

event bool GenericComponent::_WB_CanDelete	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 110 of file GenericComponent.c.

◆ _WB_CanDelete() [2/2]

event bool GenericComponent::_WB_CanDelete	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 110 of file GenericComponent.c.

◆ _WB_CanRename() [1/2]

event bool GenericComponent::_WB_CanRename	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 112 of file GenericComponent.c.

◆ _WB_CanRename() [2/2]

event bool GenericComponent::_WB_CanRename	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 112 of file GenericComponent.c.

◆ _WB_CanSelect() [1/2]

event bool GenericComponent::_WB_CanSelect	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 116 of file GenericComponent.c.

◆ _WB_CanSelect() [2/2]

event bool GenericComponent::_WB_CanSelect	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 116 of file GenericComponent.c.

◆ _WB_EnablePhysics() [1/2]

event bool GenericComponent::_WB_EnablePhysics	(	IEntity	owner,
		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 GenericComponent::_WB_EnablePhysics	(	IEntity	owner,
		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 GenericComponent::_WB_GetAfterWorldUpdateSpecs	(	IEntity	owner,
		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 GenericComponent::_WB_GetAfterWorldUpdateSpecs	(	IEntity	owner,
		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_GetContextMenuItems() [1/2]

event array< ref WB_UIMenuItem > GenericComponent::_WB_GetContextMenuItems ( IEntity owner )

protected

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

◆ _WB_GetContextMenuItems() [2/2]

event array< ref WB_UIMenuItem > GenericComponent::_WB_GetContextMenuItems ( IEntity owner )

protected

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

◆ _WB_GetKeySpaceMatrixWorld() [1/2]

event bool GenericComponent::_WB_GetKeySpaceMatrixWorld	(	IEntity	owner,
		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 130 of file GenericComponent.c.

◆ _WB_GetKeySpaceMatrixWorld() [2/2]

event bool GenericComponent::_WB_GetKeySpaceMatrixWorld	(	IEntity	owner,
		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 130 of file GenericComponent.c.

◆ _WB_GetUserEnums() [1/2]

event array< ref ParamEnum > GenericComponent::_WB_GetUserEnums	(	string	varName,
		IEntity	owner,
		IEntityComponentSource	src )

protected

Possibility to get variable value choices dynamically.

◆ _WB_GetUserEnums() [2/2]

event array< ref ParamEnum > GenericComponent::_WB_GetUserEnums	(	string	varName,
		IEntity	owner,
		IEntityComponentSource	src )

protected

Possibility to get variable value choices dynamically.

◆ _WB_IsTraceable() [1/2]

event bool GenericComponent::_WB_IsTraceable	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 118 of file GenericComponent.c.

◆ _WB_IsTraceable() [2/2]

event bool GenericComponent::_WB_IsTraceable	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 118 of file GenericComponent.c.

◆ _WB_OnContextMenu() [1/2]

event void GenericComponent::_WB_OnContextMenu	(	IEntity	owner,
		int	id )

protected

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.

◆ _WB_OnContextMenu() [2/2]

event void GenericComponent::_WB_OnContextMenu	(	IEntity	owner,
		int	id )

protected

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.

◆ _WB_OnCreate() [1/2]

event void GenericComponent::_WB_OnCreate	(	IEntity	owner,
		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 GenericComponent::_WB_OnCreate	(	IEntity	owner,
		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 GenericComponent::_WB_OnDelete	(	IEntity	owner,
		IEntitySource	src )

protected

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 GenericComponent::_WB_OnDelete	(	IEntity	owner,
		IEntitySource	src )

protected

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 GenericComponent::_WB_OnInit	(	IEntity	owner,
		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 GenericComponent::_WB_OnInit	(	IEntity	owner,
		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 GenericComponent::_WB_OnKeyChanged	(	IEntity	owner,
		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 GenericComponent::_WB_OnKeyChanged	(	IEntity	owner,
		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 GenericComponent::_WB_OnKeyDown	(	IEntity	owner,
		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 GenericComponent::_WB_OnKeyDown	(	IEntity	owner,
		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 GenericComponent::_WB_OnParentChange	(	IEntity	owner,
		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 GenericComponent::_WB_OnParentChange	(	IEntity	owner,
		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 GenericComponent::_WB_OnPhysSimulPlacementBegin	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 124 of file GenericComponent.c.

◆ _WB_OnPhysSimulPlacementBegin() [2/2]

event bool GenericComponent::_WB_OnPhysSimulPlacementBegin	(	IEntity	owner,
		IEntitySource	src )

inlineprotected

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

Definition at line 124 of file GenericComponent.c.

◆ _WB_OnRename() [1/2]

event void GenericComponent::_WB_OnRename	(	IEntity	owner,
		IEntitySource	src,
		string	oldName )

protected

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 GenericComponent::_WB_OnRename	(	IEntity	owner,
		IEntitySource	src,
		string	oldName )

protected

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 GenericComponent::_WB_SetExtraVisualiser	(	IEntity	owner,
		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 GenericComponent::_WB_SetExtraVisualiser	(	IEntity	owner,
		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 GenericComponent::_WB_SetTransform	(	IEntity	owner,
		inout vector	mat[4],
		IEntitySource	src )

protected

Editor changed entity transformation matrix source. Do not call editor API here!

◆ _WB_SetTransform() [2/2]

event void GenericComponent::_WB_SetTransform	(	IEntity	owner,
		inout vector	mat[4],
		IEntitySource	src )

protected

Editor changed entity transformation matrix source. Do not call editor API here!

◆ Activate() [1/2]

proto external void GenericComponent::Activate ( IEntity owner )

protected

Activate component and calls EOnActivate().

◆ Activate() [2/2]

proto external void GenericComponent::Activate ( IEntity owner )

protected

Activate component and calls EOnActivate().

◆ ClearEventMask() [1/2]

proto external int GenericComponent::ClearEventMask	(	notnull IEntity	owner,
		int	mask )

protected

Clears bitmask. Component accepts only events which has set bits in eventmask. Only bits set in the mask are cleared. See enf::EntityEvents

Parameters

mask	Mask of those bits, which will be cleared.

Returns: returns these bits that were set before and now are cleared.

◆ ClearEventMask() [2/2]

proto external int GenericComponent::ClearEventMask	(	notnull IEntity	owner,
		int	mask )

protected

Clears bitmask. Component accepts only events which has set bits in eventmask. Only bits set in the mask are cleared. See enf::EntityEvents

Parameters

mask	Mask of those bits, which will be cleared.

Returns: returns these bits that were set before and now are cleared.

◆ ConnectToDiagSystem() [1/2]

void GenericComponent::ConnectToDiagSystem ( IEntity owner )

protected

◆ ConnectToDiagSystem() [2/2]

void GenericComponent::ConnectToDiagSystem ( IEntity owner )

protected

◆ Deactivate() [1/2]

proto external void GenericComponent::Deactivate ( IEntity owner )

protected

Deactivate component and calls EOnDectivate().

◆ Deactivate() [2/2]

proto external void GenericComponent::Deactivate ( IEntity owner )

protected

Deactivate component and calls EOnDectivate().

◆ DisconnectFromDiagSystem() [1/2]

void GenericComponent::DisconnectFromDiagSystem ( IEntity owner )

protected

◆ DisconnectFromDiagSystem() [2/2]

void GenericComponent::DisconnectFromDiagSystem ( IEntity owner )

protected

◆ FindComponent() [1/2]

proto external GenericComponent GenericComponent::FindComponent ( typename typeName )

protected

Finds first occurance of the coresponding component.

Parameters

typeName type of the component

◆ FindComponent() [2/2]

proto external GenericComponent GenericComponent::FindComponent ( typename typeName )

protected

Finds first occurance of the coresponding component.

Parameters

typeName type of the component

◆ FindComponents() [1/2]

proto external int GenericComponent::FindComponents	(	typename typeName	,
		notnull array< GenericComponent >	outComponents )

protected

Finds all occurances of the coresponding component.

Parameters

typeName	type of the component
outComponents	array to fill with selected components

◆ FindComponents() [2/2]

proto external int GenericComponent::FindComponents	(	typename typeName	,
		notnull array< GenericComponent >	outComponents )

protected

Finds all occurances of the coresponding component.

Parameters

typeName	type of the component
outComponents	array to fill with selected components

◆ GetEventMask() [1/2]

proto external int GenericComponent::GetEventMask ( )

protected

Gets current eventmask of the component.

Returns: Returns bitmask of events the component accepts

◆ GetEventMask() [2/2]

proto external int GenericComponent::GetEventMask ( )

protected

Gets current eventmask of the component.

Returns: Returns bitmask of events the component accepts

◆ IsActive() [1/2]

proto external bool GenericComponent::IsActive ( )

protected

Returns activity state.

Returns: Returns true, if component is active.

◆ IsActive() [2/2]

proto external bool GenericComponent::IsActive ( )

protected

Returns activity state.

Returns: Returns true, if component is active.

◆ OnTransformReset() [1/2]

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

protected

Notifies the component that a transformation of the owner entity 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 component can react appropriately. By default, this is called automatically from GenericEntity::OnTransformReset.

The default implementation does nothing except calling OnTransformReset on the child components.

The default behavior may be changed in inherited components 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 owner entity after the transform reset

◆ OnTransformReset() [2/2]

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

protected

Notifies the component that a transformation of the owner entity 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 component can react appropriately. By default, this is called automatically from GenericEntity::OnTransformReset.

The default implementation does nothing except calling OnTransformReset on the child components.

The default behavior may be changed in inherited components 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 owner entity after the transform reset

◆ OnTransformResetImpl() [1/2]

void GenericComponent::OnTransformResetImpl ( TransformResetParams params )

inlineprotected

Script-side implementation of OnTransformReset.

The default implementation does nothing except calling OnTransformReset on the child components.

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 159 of file GenericComponent.c.

◆ OnTransformResetImpl() [2/2]

void GenericComponent::OnTransformResetImpl ( TransformResetParams params )

inlineprotected

Script-side implementation of OnTransformReset.

The default implementation does nothing except calling OnTransformReset on the child components.

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 159 of file GenericComponent.c.

◆ Rpc() [1/2]

void GenericComponent::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 GenericComponent::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.

◆ SetEventMask() [1/2]

proto external int GenericComponent::SetEventMask	(	notnull IEntity	owner,
		int	mask )

protected

Sets eventmask. Component accepts only events which has set bits in eventmask. Bits are or'ed with existing bitmask. See enf::EntityEvents. When this method is called in the constructor of the component, it will not properly set the eventmask to the parent entity. You may consider OnComponentInsert event.

Parameters

mask	Mask of those bits, which will be set.

Returns: Returns bitmask of events the component accepts (result of mask|GetEventMask())

◆ SetEventMask() [2/2]

proto external int GenericComponent::SetEventMask	(	notnull IEntity	owner,
		int	mask )

protected

Sets eventmask. Component accepts only events which has set bits in eventmask. Bits are or'ed with existing bitmask. See enf::EntityEvents. When this method is called in the constructor of the component, it will not properly set the eventmask to the parent entity. You may consider OnComponentInsert event.

Parameters

mask	Mask of those bits, which will be set.

Returns: Returns bitmask of events the component accepts (result of mask|GetEventMask())

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

scripts/GameLib/generated/Components/GenericComponent.c

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _WB_AfterWorldUpdate() [1/2]

◆ _WB_AfterWorldUpdate() [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_GetContextMenuItems() [1/2]

◆ _WB_GetContextMenuItems() [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_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]

◆ Activate() [1/2]

◆ Activate() [2/2]

◆ ClearEventMask() [1/2]

◆ ClearEventMask() [2/2]

◆ ConnectToDiagSystem() [1/2]

◆ ConnectToDiagSystem() [2/2]

◆ Deactivate() [1/2]

◆ Deactivate() [2/2]

◆ DisconnectFromDiagSystem() [1/2]

◆ DisconnectFromDiagSystem() [2/2]

◆ FindComponent() [1/2]

◆ FindComponent() [2/2]

◆ FindComponents() [1/2]

◆ FindComponents() [2/2]

◆ GetEventMask() [1/2]

◆ GetEventMask() [2/2]

◆ IsActive() [1/2]

◆ IsActive() [2/2]

◆ OnTransformReset() [1/2]

◆ OnTransformReset() [2/2]

◆ OnTransformResetImpl() [1/2]

◆ OnTransformResetImpl() [2/2]

◆ Rpc() [1/2]

◆ Rpc() [2/2]

◆ SetEventMask() [1/2]

◆ SetEventMask() [2/2]