WorldSystem Class Reference

Inheritance diagram for WorldSystem:

Protected Member Functions
void	BeginUpdate ()
void	Update ()
void	EndUpdate ()
void	AddEntity (notnull IEntity entity)
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)
bool	DependsOn (WorldSystemPoint point, WorldSystem system)
void	OnInit ()
void	OnCleanup ()
void	OnStarted ()
	Called every time system is started (before the first run and after Enable(true) is called.
void	OnStopped ()
	Called every time system is stopped (after Enable(false) is called and before the system is being destroyed.
void	OnUpdate (WorldSystemPoint point)
void	OnUpdatePoint (WorldUpdatePointArgs args)
	Called at specific points during World update.
void	OnOneTimePoint (WorldOneTimePointArgs args)
	Called at specific one-time events during World lifetime.
void	OnDiag (float timeSlice)
void	BeginUpdate ()
void	Update ()
void	EndUpdate ()
void	AddEntity (notnull IEntity entity)
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)
bool	DependsOn (WorldSystemPoint point, WorldSystem system)
void	OnInit ()
void	OnCleanup ()
void	OnStarted ()
	Called every time system is started (before the first run and after Enable(true) is called.
void	OnStopped ()
	Called every time system is stopped (after Enable(false) is called and before the system is being destroyed.
void	OnUpdate (WorldSystemPoint point)
void	OnUpdatePoint (WorldUpdatePointArgs args)
	Called at specific points during World update.
void	OnOneTimePoint (WorldOneTimePointArgs args)
	Called at specific one-time events during World lifetime.
void	OnDiag (float timeSlice)

Detailed Description

To create a system, you just need to create a class which inherits from WorldSystem, and then specify GetSystemPoint to your need.

Definition at line 16 of file WorldSystem.c.

Member Function Documentation

AddEntity() [1/2]

void WorldSystem::AddEntity ( notnull IEntity entity )

protected

AddEntity() [2/2]

void WorldSystem::AddEntity ( notnull IEntity entity )

protected

BeginUpdate() [1/2]

void WorldSystem::BeginUpdate ( )

protected

The 4 functions below are designed so scripters can handle a batch update of multiple entities in a performant way.

Example: override void OnUpdate() { BeginUpdate(); foreach (IEntity ent: myents) { ent.SetWorldTransform(myNewTransform); AddEntity(ent); } EndUpdate(); //< This is the call where entities are updated in batch }

BeginUpdate() [2/2]

void WorldSystem::BeginUpdate ( )

protected

The 4 functions below are designed so scripters can handle a batch update of multiple entities in a performant way.

Example: override void OnUpdate() { BeginUpdate(); foreach (IEntity ent: myents) { ent.SetWorldTransform(myNewTransform); AddEntity(ent); } EndUpdate(); //< This is the call where entities are updated in batch }

DependsOn() [1/2]

bool WorldSystem::DependsOn ( WorldSystemPoint point, WorldSystem system )

inlineprotected

Should return true for systems this system depends on. False otherwise

Deprecated

Use WorldSystemInfo.AddExecuteAfter() instead.

Definition at line 65 of file WorldSystem.c.

DependsOn() [2/2]

bool WorldSystem::DependsOn ( WorldSystemPoint point, WorldSystem system )

inlineprotected

Should return true for systems this system depends on. False otherwise

Deprecated

Use WorldSystemInfo.AddExecuteAfter() instead.

Definition at line 65 of file WorldSystem.c.

EndUpdate() [1/2]

void WorldSystem::EndUpdate ( )

protected

EndUpdate() [2/2]

void WorldSystem::EndUpdate ( )

protected

OnCleanup() [1/2]

void WorldSystem::OnCleanup ( )

protected

Called when system are to be cleaned up. This always happens at any point when simulation decides to bring the system back to the initial state without actually destroying it.

OnCleanup() [2/2]

void WorldSystem::OnCleanup ( )

protected

Called when system are to be cleaned up. This always happens at any point when simulation decides to bring the system back to the initial state without actually destroying it.

OnDiag() [1/2]

void WorldSystem::OnDiag ( float timeSlice )

protected

OnDiag() [2/2]

void WorldSystem::OnDiag ( float timeSlice )

protected

OnInit() [1/2]

void WorldSystem::OnInit ( )

protected

Called when system are to be intialized. This always happens at any point when simulation decides to reinitialize the system without actually destroying it.

OnInit() [2/2]

void WorldSystem::OnInit ( )

protected

Called when system are to be intialized. This always happens at any point when simulation decides to reinitialize the system without actually destroying it.

OnOneTimePoint() [1/2]

void WorldSystem::OnOneTimePoint ( WorldOneTimePointArgs args )

protected

Called at specific one-time events during World lifetime.

OnOneTimePoint() [2/2]

void WorldSystem::OnOneTimePoint ( WorldOneTimePointArgs args )

protected

Called at specific one-time events during World lifetime.

OnStarted() [1/2]

void WorldSystem::OnStarted ( )

protected

Called every time system is started (before the first run and after Enable(true) is called.

OnStarted() [2/2]

void WorldSystem::OnStarted ( )

protected

Called every time system is started (before the first run and after Enable(true) is called.

OnStopped() [1/2]

void WorldSystem::OnStopped ( )

protected

Called every time system is stopped (after Enable(false) is called and before the system is being destroyed.

OnStopped() [2/2]

void WorldSystem::OnStopped ( )

protected

Called every time system is stopped (after Enable(false) is called and before the system is being destroyed.

OnUpdate() [1/2]

void WorldSystem::OnUpdate ( WorldSystemPoint point )

protected

Deprecated

Override OnUpdatePoint() instead.

OnUpdate() [2/2]

void WorldSystem::OnUpdate ( WorldSystemPoint point )

protected

Deprecated

Override OnUpdatePoint() instead.

OnUpdatePoint() [1/2]

void WorldSystem::OnUpdatePoint ( WorldUpdatePointArgs args )

protected

Called at specific points during World update.

OnUpdatePoint() [2/2]

void WorldSystem::OnUpdatePoint ( WorldUpdatePointArgs args )

protected

Called at specific points during World update.

Rpc() [1/2]

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

Update() [1/2]

void WorldSystem::Update ( )

protected

Update() [2/2]

void WorldSystem::Update ( )

protected

---

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

• scripts/GameLib/generated/WorldSystems/WorldSystem.c