ScriptComponent Class Reference

Inheritance diagram for ScriptComponent:

Protected Member Functions
bool	RplLoad (ScriptBitReader reader)
bool	RplSave (ScriptBitWriter writer)
proto external GenericEntity	GetOwner ()
	Get owner entity.
void	EOnTouch (IEntity owner, IEntity other, int touchTypesMask)
void	EOnInit (IEntity owner)
void	EOnVisible (IEntity owner, int frameNumber)
void	EOnFrame (IEntity owner, float timeSlice)
void	EOnPostFrame (IEntity owner, float timeSlice)
void	EOnAnimEvent (IEntity owner, int type, int slot)
void	EOnSimulate (IEntity owner, float timeSlice)
void	EOnPostSimulate (IEntity owner, float timeSlice)
void	EOnJointBreak (IEntity owner, IEntity other)
void	EOnPhysicsMove (IEntity owner)
void	EOnContact (IEntity owner, IEntity other, Contact contact)
void	EOnPhysicsActive (IEntity owner, bool activeState)
void	EOnDiag (IEntity owner, float timeSlice)
void	EOnFixedFrame (IEntity owner, float timeSlice)
void	EOnPostFixedFrame (IEntity owner, float timeSlice)
void	EOnActivate (IEntity owner)
void	EOnDeactivate (IEntity owner)
void	OnPostInit (IEntity owner)
void	OnDelete (IEntity owner)
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.
bool	RplLoad (ScriptBitReader reader)
bool	RplSave (ScriptBitWriter writer)
proto external GenericEntity	GetOwner ()
	Get owner entity.
void	EOnTouch (IEntity owner, IEntity other, int touchTypesMask)
void	EOnInit (IEntity owner)
void	EOnVisible (IEntity owner, int frameNumber)
void	EOnFrame (IEntity owner, float timeSlice)
void	EOnPostFrame (IEntity owner, float timeSlice)
void	EOnAnimEvent (IEntity owner, int type, int slot)
void	EOnSimulate (IEntity owner, float timeSlice)
void	EOnPostSimulate (IEntity owner, float timeSlice)
void	EOnJointBreak (IEntity owner, IEntity other)
void	EOnPhysicsMove (IEntity owner)
void	EOnContact (IEntity owner, IEntity other, Contact contact)
void	EOnPhysicsActive (IEntity owner, bool activeState)
void	EOnDiag (IEntity owner, float timeSlice)
void	EOnFixedFrame (IEntity owner, float timeSlice)
void	EOnPostFixedFrame (IEntity owner, float timeSlice)
void	EOnActivate (IEntity owner)
void	EOnDeactivate (IEntity owner)
void	OnPostInit (IEntity owner)
void	OnDelete (IEntity owner)
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.

Detailed Description

Parent class for all components created in script. Every ScriptComponent is being created in Entity's constructor and may receive following events

1. OnComponentInsert is being called when component is created. This is last event Workbench sends in World Editor edit mode.
2. EOnInit is being called after all components have been inserted and if the component registered event mask EV_INIT
3. EOnActivate is being called if the entity was flagged as TFL_ACTIVE and if the component is active. The component is active by default.
4. EOnXXXs are being called base on event mask component registered
5. EOnDeactivate is being called when Deactivate is called or when the component is being to be removed. Component must be active to be deactivated.
6. OnComponentRemove is being called after a component is removed.
7. EOnDelete is being called after entity is going to be destroyed.

Definition at line 23 of file ScriptComponent.c.

Member Function Documentation

EOnActivate() [1/2]

void ScriptComponent::EOnActivate ( IEntity owner )

protected

Event when component is activated.

EOnActivate() [2/2]

void ScriptComponent::EOnActivate ( IEntity owner )

protected

Event when component is activated.

EOnAnimEvent() [1/2]

void ScriptComponent::EOnAnimEvent ( IEntity owner, int type, int slot )

protected

Event from animation system

Parameters

owner	The owner entity
type
slot

EOnAnimEvent() [2/2]

void ScriptComponent::EOnAnimEvent ( IEntity owner, int type, int slot )

protected

Event from animation system

Parameters

owner	The owner entity
type
slot

EOnContact() [1/2]

void ScriptComponent::EOnContact ( IEntity owner, IEntity other, Contact contact )

protected

Event when physics engine registered contact with other RigidBody

Parameters

owner	The owner entity
other	Other Entity who contacted us
contact	Structure describing the contact

EOnContact() [2/2]

void ScriptComponent::EOnContact ( IEntity owner, IEntity other, Contact contact )

protected

Event when physics engine registered contact with other RigidBody

Parameters

owner	The owner entity
other	Other Entity who contacted us
contact	Structure describing the contact

EOnDeactivate() [1/2]

void ScriptComponent::EOnDeactivate ( IEntity owner )

protected

Event when component is deactivated.

EOnDeactivate() [2/2]

void ScriptComponent::EOnDeactivate ( IEntity owner )

protected

Event when component is deactivated.

EOnDiag() [1/2]

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

protected

Event every frame after EOnFrame, when "Entity diag" is enabled from the debug menu

Parameters

owner	The owner entity
timeSlice	Time slice of simulation step

EOnDiag() [2/2]

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

protected

Event every frame after EOnFrame, when "Entity diag" is enabled from the debug menu

Parameters

owner	The owner entity
timeSlice	Time slice of simulation step

EOnFixedFrame() [1/2]

void ScriptComponent::EOnFixedFrame ( IEntity owner, float timeSlice )

protected

Event every fixed frame.

Parameters

owner	The owner entity
timeSlice	Fixed time step

EOnFixedFrame() [2/2]

void ScriptComponent::EOnFixedFrame ( IEntity owner, float timeSlice )

protected

Event every fixed frame.

Parameters

owner	The owner entity
timeSlice	Fixed time step

EOnFrame() [1/2]

void ScriptComponent::EOnFrame ( IEntity owner, float timeSlice )

protected

Event every frame

Parameters

owner	The owner entity
timeSlice	Time passed since last frame

EOnFrame() [2/2]

void ScriptComponent::EOnFrame ( IEntity owner, float timeSlice )

protected

Event every frame

Parameters

owner	The owner entity
timeSlice	Time passed since last frame

EOnInit() [1/2]

void ScriptComponent::EOnInit ( IEntity owner )

protected

Event after entity is allocated and initialized.

Parameters

owner

The owner entity

EOnInit() [2/2]

void ScriptComponent::EOnInit ( IEntity owner )

protected

Event after entity is allocated and initialized.

Parameters

owner

The owner entity

EOnJointBreak() [1/2]

void ScriptComponent::EOnJointBreak ( IEntity owner, IEntity other )

protected

Event when joint attached to RigidBody of this entity is broken

Parameters

owner	The owner entity
other	Other Entity attached to the joint

EOnJointBreak() [2/2]

void ScriptComponent::EOnJointBreak ( IEntity owner, IEntity other )

protected

Event when joint attached to RigidBody of this entity is broken

Parameters

owner	The owner entity
other	Other Entity attached to the joint

EOnPhysicsActive() [1/2]

void ScriptComponent::EOnPhysicsActive ( IEntity owner, bool activeState )

protected

Event when a RigidBody active state is changed between consecutive fixed steps

Parameters

owner

The owner entity

EOnPhysicsActive() [2/2]

void ScriptComponent::EOnPhysicsActive ( IEntity owner, bool activeState )

protected

Event when a RigidBody active state is changed between consecutive fixed steps

Parameters

owner

The owner entity

EOnPhysicsMove() [1/2]

void ScriptComponent::EOnPhysicsMove ( IEntity owner )

protected

Event when physics engine has moved with this Entity

Parameters

owner

The owner entity

EOnPhysicsMove() [2/2]

void ScriptComponent::EOnPhysicsMove ( IEntity owner )

protected

Event when physics engine has moved with this Entity

Parameters

owner

The owner entity

EOnPostFixedFrame() [1/2]

void ScriptComponent::EOnPostFixedFrame ( IEntity owner, float timeSlice )

protected

Event after physics update on every fixed frame.

Parameters

owner	The owner entity
timeSlice	Fixed time step

EOnPostFixedFrame() [2/2]

void ScriptComponent::EOnPostFixedFrame ( IEntity owner, float timeSlice )

protected

Event after physics update on every fixed frame.

Parameters

owner	The owner entity
timeSlice	Fixed time step

EOnPostFrame() [1/2]

void ScriptComponent::EOnPostFrame ( IEntity owner, float timeSlice )

protected

Event after physics update.

Parameters

owner	The owner entity
timeSlice	Time passed since last frame

EOnPostFrame() [2/2]

void ScriptComponent::EOnPostFrame ( IEntity owner, float timeSlice )

protected

Event after physics update.

Parameters

owner	The owner entity
timeSlice	Time passed since last frame

EOnPostSimulate() [1/2]

void ScriptComponent::EOnPostSimulate ( IEntity owner, float timeSlice )

protected

Event after every physics fixed step (can be multiple calls per engine update)

Parameters

owner	The owner entity
timeSlice	Time slice of physics fixed step

EOnPostSimulate() [2/2]

void ScriptComponent::EOnPostSimulate ( IEntity owner, float timeSlice )

protected

Event after every physics fixed step (can be multiple calls per engine update)

Parameters

owner	The owner entity
timeSlice	Time slice of physics fixed step

EOnSimulate() [1/2]

void ScriptComponent::EOnSimulate ( IEntity owner, float timeSlice )

protected

Event before every physics fixed step (can be multiple calls per engine update)

Parameters

owner	The owner entity
timeSlice	Time slice of physics fixed step

EOnSimulate() [2/2]

void ScriptComponent::EOnSimulate ( IEntity owner, float timeSlice )

protected

Event before every physics fixed step (can be multiple calls per engine update)

Parameters

owner	The owner entity
timeSlice	Time slice of physics fixed step

EOnTouch() [1/2]

void ScriptComponent::EOnTouch ( IEntity owner, IEntity other, int touchTypesMask )

protected

Event when touched by other entity.

Note

You need to have TouchComponent in entity to receive this event.

Parameters

owner	The owner entity
other	Entity who touched us
touchTypesMask	Bitmask of touch types TouchEvent

EOnTouch() [2/2]

void ScriptComponent::EOnTouch ( IEntity owner, IEntity other, int touchTypesMask )

protected

Event when touched by other entity.

Note

You need to have TouchComponent in entity to receive this event.

Parameters

owner	The owner entity
other	Entity who touched us
touchTypesMask	Bitmask of touch types TouchEvent

EOnVisible() [1/2]

void ScriptComponent::EOnVisible ( IEntity owner, int frameNumber )

protected

Event when we are visible

Parameters

owner	The owner entity
frameNumber	Frame number

EOnVisible() [2/2]

void ScriptComponent::EOnVisible ( IEntity owner, int frameNumber )

protected

Event when we are visible

Parameters

owner	The owner entity
frameNumber	Frame number

GetOwner() [1/2]

proto external GenericEntity ScriptComponent::GetOwner ( )

protected

Get owner entity.

GetOwner() [2/2]

proto external GenericEntity ScriptComponent::GetOwner ( )

protected

Get owner entity.

OnAddedToParent() [1/2]

void ScriptComponent::OnAddedToParent ( IEntity child, IEntity parent )

protected

Called on child entity when it is added into hierarchy.

OnAddedToParent() [2/2]

void ScriptComponent::OnAddedToParent ( IEntity child, IEntity parent )

protected

Called on child entity when it is added into hierarchy.

OnChildAdded() [1/2]

void ScriptComponent::OnChildAdded ( IEntity parent, IEntity child )

protected

Called on parent entity when child entity is added into hierarchy.

OnChildAdded() [2/2]

void ScriptComponent::OnChildAdded ( IEntity parent, IEntity child )

protected

Called on parent entity when child entity is added into hierarchy.

OnChildRemoved() [1/2]

void ScriptComponent::OnChildRemoved ( IEntity parent, IEntity child )

protected

Called on parent entity when child entity is removed from hierarchy.

OnChildRemoved() [2/2]

void ScriptComponent::OnChildRemoved ( IEntity parent, IEntity child )

protected

Called on parent entity when child entity is removed from hierarchy.

OnDelete() [1/2]

void ScriptComponent::OnDelete ( IEntity owner )

protected

Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game::DeleteScriptComponent).

Parameters

owner

Entity which owns the component

OnDelete() [2/2]

void ScriptComponent::OnDelete ( IEntity owner )

protected

Called when Entity is being to be destroyed (deleted) or component to be deleted (see Game::DeleteScriptComponent).

Parameters

owner

Entity which owns the component

OnPostInit() [1/2]

void ScriptComponent::OnPostInit ( IEntity owner )

protected

Event called after init when all components are initialized.

Parameters

owner

Entity into which component is added

OnPostInit() [2/2]

void ScriptComponent::OnPostInit ( IEntity owner )

protected

Event called after init when all components are initialized.

Parameters

owner

Entity into which component is added

OnRemovedFromParent() [1/2]

void ScriptComponent::OnRemovedFromParent ( IEntity child, IEntity parent )

protected

Called on child entity when it is removed from hierarchy.

OnRemovedFromParent() [2/2]

void ScriptComponent::OnRemovedFromParent ( IEntity child, IEntity parent )

protected

Called on child entity when it is removed from hierarchy.

RplLoad() [1/2]

bool ScriptComponent::RplLoad ( ScriptBitReader reader )

protected

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

RplLoad() [2/2]

bool ScriptComponent::RplLoad ( ScriptBitReader reader )

protected

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

RplSave() [1/2]

bool ScriptComponent::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 ScriptComponent::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.

---

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

• scripts/GameLib/generated/Components/ScriptComponent.c