Cocos2D JavaScript (v0.2.0-beta) API Documentation

BObject
- Action

Class: Action

Module: cocos.actions
Defined In: actions/Action.js
Subclasses: FiniteTimeAction; Follow; RepeatForever; Speed
Extends: BObject

Base class for Actions

Public Properties

Property		Defined By
Expand id	id : Integer <read-only> Unique ID for this object	BObject
Expand isDone	isDone : * <read-only>	Action
Expand tag	tag : * Unique tag to identify the action	Action
Expand target	target : cocos.nodes.Node The Node the action is being performed on	Action

Public Methods

Method		Defined By
Expand Action	new Action () : cocos.actions.Action <constructor> Returns cocos.actions.Action New instance of cocos.actions.Action	Action
Expand bindTo	bindTo (key:String,target:BOject,[targetKey:String],[noNotify:Boolean]) : void Bind the value of a property on this object to that of another object so they always have the same value. Setting the value on either object will update the other too. Arguments key : String Name of the property on this object that should be bound target : BOject Object to bind to targetKey : String (Optional) Key on the target object to bind to noNotify : Boolean (Optional) Set to true to prevent this object's property triggering a 'changed' event when adding the binding Returns void	BObject
Expand changed	changed (key:*) : void Arguments key : Returns void	BObject
Expand get	get (key:String) : * Get a property from the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly. Arguments key : String Name of property to get or dot (.) separated path to a property Returns * Value of the property	BObject
Expand reverse	reverse () : cocos.actions.Action Returns a copy of this Action but in reverse Returns cocos.actions.Action A new Action in reverse	Action
Expand set	set (key:String,value:) : void Set a property on the object. Always use this instead of trying to access the property directly. This will ensure all bindings, setters and getters work correctly. Arguments key : String Name of property to get value : New value for the property Returns void	BObject
Expand setValues	setValues (kvp:Object) : void Set multiple propertys in one go Arguments kvp : Object An Object where the key is a property name and the value is the value to assign to the property Returns void	BObject
Expand startWithTarget	startWithTarget (target:cocos.nodes.Node) : void Called before the action start. It will also set the target. Arguments target : cocos.nodes.Node The Node to run the action on Returns void	Action
Expand step	step (dt:Float) : void Called every frame with it's delta time. Arguments dt : Float The delta time Returns void	Action
Expand stop	stop () : void Called after the action has finished. It will set the 'target' to nil. Important: You should never call cocos.actions.Action#stop manually. Instead, use cocos.nodes.Node#stopAction(action) Returns void	Action
Expand unbind	unbind (key:String) : void Remove binding from a property which set setup using BObject#bindTo. Arguments key : String Name of the property on this object to unbind Returns void	BObject
Expand unbindAll	unbindAll () : void Remove all bindings on this object Returns void	BObject
Expand update	update (time:Float) : void Called once per frame. Arguments time : Float How much of the animation has played. 0.0 = just started, 1.0 just finished. Returns void	Action

Private Members

This class has no private members.