Class Index | File Index

Classes


Class VENISON.PROPERTY.Property

The ABSTRACT base class for all properties. NOTE: Never instanciate this one!
Defined in: venison_engine.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
The attributes object to extend the attributes object of the entity on attachment.
 
The entity that this property is attached to.
Method Summary
Method Attributes Method Name and Description
 
Override in subclass (NOTE: this is implicitly done in VENISON.PROPERTY.PropertyFactory.fnRegisterProperty(), so don't do it explicitly!)
 
fnHandleMessage(iMessage)
Override in subclass.
 
Override in subclass.
 
Override in subclass.
 
Override in subclass.
 
Override in subclass.
 
Override in subclass.
Class Detail
VENISON.PROPERTY.Property()
Field Detail
{Object} attributes
The attributes object to extend the attributes object of the entity on attachment. Override in subclasses as needed.

{VENISON.ENTITY.GameEntity} entity
The entity that this property is attached to. DO NOT override in subclass, and DO NOT alter explicitly.
Method Detail
{String} fnGetName()
Override in subclass (NOTE: this is implicitly done in VENISON.PROPERTY.PropertyFactory.fnRegisterProperty(), so don't do it explicitly!)
Returns:
{String} The name of this property

fnHandleMessage(iMessage)
Override in subclass. Called when the game entity that this property is attached to receives a message of a type that this property has registered itself to.
Parameters:
{Object} iMessage
the message received.

fnOnAttached()
Override in subclass. Called when this property has been attached to an entity. mEntity contains a pointer to the entity.

fnOnFrame()
Override in subclass. Called once every frame.

fnOnLevelLoaded()
Override in subclass. Called when the level has been completely loaded.

fnOnRemoved()
Override in subclass. Called when this property is removed from the entity it was attached to.

fnRegisterToMessages()
Override in subclass. This method is automatically called when this property is attached to an entity. Use it to register which messages this property should be notified of.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 05 2011 18:47:29 GMT+0200 (CEST)