| Property | Defined By | ||
|---|---|---|---|
 | baseClass : Object [read-only]
Returns the entity base class. | Entity | |
| defaultHealth : int [read-only]
A getter that returns the default health the entity has. | Entity | |
| _display : Boolean [read-only]
Returns if this entity base contains display functionality (will not Init until spawned). | Entity | |
| _dynamic : Boolean [read-only]
Returns if the entity is dynamic. | Entity | |
| health : int [read-only]
A getter that returns the current health value of the entity. | Entity | |
| _id : int
Returns the registration ID of the entity. | Entity | |
| maxHealth : int
A getter that returns the maximum health this entity can have. | Entity | |
| x : Number
Returns the X position of the emitter
| SoundEmitter | ||
| Method | Defined By | ||
|---|---|---|---|
| _Dispose():void
Cleans the entity's data. | Entity | |
| _Update():void
Called each engine tick, do not override this. | Entity | |
| Construct():void
Called before the entity is spawned to setup the constants of the entity. | Entity | |
| DeInit():void
Called when the entity is deleted. | Entity | |
| EnableUpdate(bUpdate:Boolean = true):void
Sets if the entity will update each engine tick. | Entity | |
| GetClass():Object
Returns the class of the entity. | Entity | |
| GetOwner():Object
Returns the current owner of the entity. | Entity | |
| GetType():String
Returns the current string type of the entity. | Entity | |
| Init():void
Called when the entity is first registered/spawned. | Entity | |
| Is(cClass:Class):Boolean
Returns if the entity matches a class. | Entity | |
| IsDead():Boolean
Returns if the entity is dead. | Entity | |
| IsHealthZero():Boolean
Returns if the health is zero. | Entity | |
| IsProtected():Boolean
Returns if the entity is protected. | Entity | |
| IsT(sCheckType:String):Boolean
Returns if the entity is matches a type (lowercase only). | Entity | |
| IsUpdating():Boolean
Returns if the entity is updating. | Entity | |
| Remove():void
Marks the entity for removal. | Entity | |
| RemoveAllHealth():void
Removes all health of the entity. | Entity | |
| Reset():void
Resets the entity to its original values. | Entity | |
| ResetHealth():void
Resets the entity's health to the default health. | Entity | |
| SetDefaultHealth(setHealth:int = 100):void
Sets the default health of this entity. | Entity | |
| SetHealth(newHealth:int):void
Sets the health value of this entity. | Entity | |
| SetOwner(newOwner:Object):void
Sets the owner of the entity. | Entity | |
| SetProtected(bProtected:Boolean = true):void
Protects an entity from being removed by clean up
calls, such as CleanSlate. | Entity | |
| SetType(sSetType:String):void
Sets the string type of the entity. | Entity | |
SetVolume(nNewVolume:Number):void
Sets the volume of the emitting sound
| SoundEmitter | ||
StartEmitting(sSound:*, nStartVolume:Number = 1, bLoops:Boolean = false):void
Starts emitting a location based sound
| SoundEmitter | ||
StopEmitting(bFade:Boolean = false):void
Stops emitting the sound and kills the emitter
| SoundEmitter | ||
| TakeDamage(iDamageAmount:int):void
Subtracts the current health. | Entity | |
| Update():void
Called each engine tick. | Entity | |
| x | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesx:NumberReturns the X position of the emitter
public function get x():Number public function set x(value:Number):void| SetVolume | () | method |
public function SetVolume(nNewVolume:Number):voidSets the volume of the emitting sound
Parameters
nNewVolume:Number |
| StartEmitting | () | method |
public function StartEmitting(sSound:*, nStartVolume:Number = 1, bLoops:Boolean = false):voidStarts emitting a location based sound
Parameters
sSound:* | |
nStartVolume:Number (default = 1) | |
bLoops:Boolean (default = false) |
| StopEmitting | () | method |
public function StopEmitting(bFade:Boolean = false):voidStops emitting the sound and kills the emitter
Parameters
bFade:Boolean (default = false) |