Class Index | File Index

Classes


Class R.components.transform.PlatformMover2D


Extends R.components.Transform2D.
A transform component to move around a tile map like the old "platformer" games
Defined in: platformmover2d.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
R.components.transform.PlatformMover2D(name, tileMap, priority)
Creates a transform component.
Fields borrowed from class R.components.Base:
TYPE_COLLIDER, TYPE_INPUT, TYPE_LOGIC, TYPE_RENDERING, TYPE_TRANSFORM
Method Summary
Method Attributes Method Name and Description
 
execute(renderContext, time, dt)
This method is called by the game object to run the component, updating its state.
 
Get the class name of this object
 
Releases the component back into the pool for reuse.
Methods borrowed from class R.components.Transform2D:
destroy, getLastPosition, getLastRenderPosition, getPosition, getRenderPosition, getRenderRotation, getRenderScale, getRenderScaleX, getRenderScaleY, getRotation, getScale, getScaleX, getScaleY, setLastPosition, setPosition, setRotation, setScale
Methods borrowed from class R.components.Base:
getGameObject, getHostObject, getPriority, getType, getTypeString, setGameObject, setHostObject, setPriority
Methods borrowed from class R.engine.BaseObject:
addEvent, addEvents, getElement, jQ, removeEvent, setElement, triggerEvent, update
Methods borrowed from class R.engine.PooledObject:
clearObjectDataModel, getId, getName, getObjectDataModel, getProperties, isDestroyed, setName, setObjectDataModel, toString, toXML
Class Detail
R.components.transform.PlatformMover2D(name, tileMap, priority)
Creates a transform component.
Parameters:
name
{String} Name of the component
tileMap
{R.resources.types.TileMap} The tile map to move around in
priority
{Number} Between 0.0 and 1.0, with 1.0 being highest
Method Detail
execute(renderContext, time, dt)
This method is called by the game object to run the component, updating its state.
Parameters:
renderContext
{R.rendercontexts.AbstractRenderContext} The context the component will render within.
time
{Number} The global engine time
dt
{Number} The delta between the world time and the last time the world was updated in milliseconds.

{String} getClassName()
Get the class name of this object
Returns:
{String} "R.components.transform.PlatformMover2D"

release()
Releases the component back into the pool for reuse. See PooledObject#release for more information.

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 18 2013 16:09:18 GMT-0400 (EDT)