Class Index | File Index

Classes


Class R.components.logic.behaviors.Seek


Extends R.components.logic.behaviors.BaseBehavior.
The seek behavior component. Causes an object to move toward a target.
Defined in: seek.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
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.
 
True if the object is near its destination.
 
setTarget(target)
Set the target to seek.
Methods borrowed from class R.components.logic.behaviors.BaseBehavior:
getTransformComponent, setTransformComponent
Methods borrowed from class R.components.Logic:
getClassName
Methods borrowed from class R.components.Base:
getGameObject, getHostObject, getPriority, getType, getTypeString, release, setGameObject, setHostObject, setPriority
Methods borrowed from class R.engine.BaseObject:
addEvent, addEvents, destroy, 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.logic.behaviors.Seek(target)
Parameters:
target
{R.math.Point2D|R.objects.Object2D} The point, or R.objects.Object2D, toward which the vehicle should seek
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.

{Boolean} isArrived()
True if the object is near its destination. You can change the "near" distance, by setting R.Engine.options.behaviors.seekNearDistance.
Returns:
{Boolean}

setTarget(target)
Set the target to seek.
Parameters:
target
{R.math.Point2D|R.objects.Object2D} The point, or object, to seek.

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