| Package | PBLabs.Engine.Components |
| Class | public class TickedComponent |
| Inheritance | TickedComponent  EntityComponent |
| Implements | ITickedObject |
| Subclasses | SimpleSpatialComponent |
| Property | Defined by | ||
|---|---|---|---|
 | IsRegistered : Boolean
Whether or not the component is currently registered with an entity.
| EntityComponent | |
| Name : String
The name given to the component when it is added to an entity.
| EntityComponent | |
| Owner : IEntity
A reference to the entity that this component currently belongs to.
| EntityComponent | |
| RegisterForTicks : Boolean = true
Do we actually want to register for ticks? Useful if a subclass wants
to disable the functionality.
| TickedComponent | ||
| UpdatePriority : Number = 0.0
The update priority for this component.
| TickedComponent | ||
| Method | Defined by | ||
|---|---|---|---|
|
OnInterpolateTick(factor:Number):void
This method is called every frame by the ProcessManager on any objects
that have been added to it with the AddTickedObject method.
| TickedComponent | ||
|
OnTick(tickRate:Number):void
This method is called every tick by the ProcessManager on any objects
that have been added to it with the AddTickedObject method.
| TickedComponent | ||
|
Registers the component with an entity.
| EntityComponent | |
|
Reset():void
This is called by an entity on all of its components any time a component
is added or removed.
| EntityComponent | |
|
Unregister():void
Unregisters the component from an entity.
| EntityComponent | |
| Method | Defined by | ||
|---|---|---|---|
|
_OnAdd():void
| TickedComponent | ||
|
_OnRemove():void
| TickedComponent | ||
|
_OnReset():void
This is called anytime a component is added or removed from the owner entity.
| EntityComponent | |
| RegisterForTicks | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var RegisterForTicks:Boolean = trueDo we actually want to register for ticks? Useful if a subclass wants to disable the functionality. Only checked at _OnAdd/_OnRemove time.
| UpdatePriority | property |
public var UpdatePriority:Number = 0.0The update priority for this component. Higher numbered priorities have OnInterpolateTick and OnTick called before lower priorities.
| _OnAdd | () | method |
protected override function _OnAdd():void
| _OnRemove | () | method |
protected override function _OnRemove():void
| OnInterpolateTick | () | method |
public function OnInterpolateTick(factor:Number):voidThis method is called every frame by the ProcessManager on any objects that have been added to it with the AddTickedObject method.
This method should be used to interpolate data between its state on the previous tick and its state on the upcoming tick.
Parametersfactor:Number — This is a number between 0 and 1 with 0 representing the
previous tick and 1 representing the next tick. In other words, it is
the percentage of time between ticks the current frame is.
|
| OnTick | () | method |
public function OnTick(tickRate:Number):voidThis method is called every tick by the ProcessManager on any objects that have been added to it with the AddTickedObject method.
ParameterstickRate:Number — The amount of time (in seconds) specified for a tick.
|