C# Class Artemis.Engine.UpdatableObject

Inheritance: Artemis.Engine.Utilities.Partial.PartialEngineAdapter
Datei anzeigen Open project: ArtemisEngine/Artemis-Engine Class Usage Examples

Public Properties

Property Type Description
DisallowMultipleUpdates bool

Public Methods

Method Description
AddUpdater ( Updater updater ) : void

Add an updater to this object.
AuxiliaryUpdate ( ) : void
ClearUpdater ( ) : void

Remove all updaters from this object.
Kill ( ) : void
Pause ( ) : void

Pause automatic updating. This will only have an effect if ManuallyUpdate is false, in which case the engine automatically updates the object. Regardless of whether or not automatic updating is paused, directly calling "Update" will still update the object.
RemoveUpdater ( Updater updater ) : void

Remove an updater from this object.
SetUpdater ( Updater updater ) : void

Set the updater for this object.
UnPause ( ) : void

Resume automatic updating.
Update ( ) : void

Private Methods

Method Description
InternalUpdate ( ) : void

This is the update method for everything that must be updated every frame regardless of the values of IsPaused or ManuallyUpdate. InternalUpdate is always called by the engine once per game tick, unless the user manually calls "Update". For example, TimeableObject uses InternalUpdate to update it's internal lifetime. This can only be called once every game tick and MUST be called.
UpdatableObject ( ) : Artemis.Engine.Utilities

Method Details

AddUpdater() public method

Add an updater to this object.
public AddUpdater ( Updater updater ) : void
updater Updater
return void

AuxiliaryUpdate() public method

public AuxiliaryUpdate ( ) : void
return void

ClearUpdater() public method

Remove all updaters from this object.
public ClearUpdater ( ) : void
return void

Kill() public method

public Kill ( ) : void
return void

Pause() public method

Pause automatic updating. This will only have an effect if ManuallyUpdate is false, in which case the engine automatically updates the object. Regardless of whether or not automatic updating is paused, directly calling "Update" will still update the object.
public Pause ( ) : void
return void

RemoveUpdater() public method

Remove an updater from this object.
public RemoveUpdater ( Updater updater ) : void
updater Updater
return void

SetUpdater() public method

Set the updater for this object.
public SetUpdater ( Updater updater ) : void
updater Updater
return void

UnPause() public method

Resume automatic updating.
public UnPause ( ) : void
return void

Update() public method

public Update ( ) : void
return void

Property Details

DisallowMultipleUpdates public_oe property

Whether or not "Update" can be called multiple times in a single game tick.
public bool DisallowMultipleUpdates
return bool