--------------------------------
-- @module Node
-- @extend Ref
-- @parent_module cc
--------------------------------
-- @overload self, cc.Node, int
-- @overload self, cc.Node
-- @overload self, cc.Node, int, int
-- @overload self, cc.Node, int, string
-- @function [parent=#Node] addChild
-- @param self
-- @param #cc.Node child
-- @param #int localZOrder
-- @param #string name
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- @overload self, cc.Component
-- @overload self, string
-- @function [parent=#Node] removeComponent
-- @param self
-- @param #string name
-- @return bool#bool ret (return value: bool)
--------------------------------
--
-- @function [parent=#Node] setPhysicsBody
-- @param self
-- @param #cc.PhysicsBody physicsBody
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Gets the description string. It makes debugging easier.
-- return A string
-- js NA
-- lua NA
-- @function [parent=#Node] getDescription
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
-- Sets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.
-- The difference between `setRotationalSkew()` and `setSkew()` is that the first one simulate Flash's skew functionality,
-- while the second one uses the real skew function.
-- 0 is the default rotation angle.
-- Positive values rotate node clockwise, and negative values for anti-clockwise.
-- param rotationY The Y rotation in degrees.
-- warning The physics body doesn't support this.
-- js setRotationY
-- @function [parent=#Node] setRotationSkewY
-- @param self
-- @param #float rotationY
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- If you want the opacity affect the color property, then set to true.
-- param value A boolean value.
-- @function [parent=#Node] setOpacityModifyRGB
-- @param self
-- @param #bool value
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Change node's cascadeOpacity property.
-- param cascadeOpacityEnabled True to enable cascadeOpacity, false otherwise.
-- @function [parent=#Node] setCascadeOpacityEnabled
-- @param self
-- @param #bool cascadeOpacityEnabled
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- @overload self
-- @overload self
-- @function [parent=#Node] getChildren
-- @param self
-- @return array_table#array_table ret (return value: array_table)
--------------------------------
-- Set the callback of event onExit.
-- param callback A std::function callback.
-- @function [parent=#Node] setOnExitCallback
-- @param self
-- @param #function callback
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the ActionManager object that is used by all actions.
-- warning If you set a new ActionManager, then previously created actions will be removed.
-- param actionManager A ActionManager object that is used by all actions.
-- @function [parent=#Node] setActionManager
-- @param self
-- @param #cc.ActionManager actionManager
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Converts a local Vec2 to world space coordinates.The result is in Points.
-- treating the returned/received node point as anchor relative.
-- param nodePoint A given coordinate.
-- return A point in world space coordinates, anchor relative.
-- @function [parent=#Node] convertToWorldSpaceAR
-- @param self
-- @param #vec2_table nodePoint
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Gets whether the anchor point will be (0,0) when you position this node.
-- see `setIgnoreAnchorPointForPosition(bool)`
-- return true if the anchor point will be (0,0) when you position this node.
-- @function [parent=#Node] isIgnoreAnchorPointForPosition
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Gets a child from the container with its name.
-- param name An identifier to find the child node.
-- return a Node object whose name equals to the input parameter.
-- since v3.2
-- @function [parent=#Node] getChildByName
-- @param self
-- @param #string name
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Update the displayed opacity of node with it's parent opacity;
-- param parentOpacity The opacity of parent node.
-- @function [parent=#Node] updateDisplayedOpacity
-- @param self
-- @param #unsigned char parentOpacity
-- @return Node#Node self (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] init
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- get & set camera mask, the node is visible by the camera whose camera flag & node's camera mask is true
-- @function [parent=#Node] getCameraMask
-- @param self
-- @return unsigned short#unsigned short ret (return value: unsigned short)
--------------------------------
-- Sets the rotation (angle) of the node in degrees.
-- 0 is the default rotation angle.
-- Positive values rotate node clockwise, and negative values for anti-clockwise.
-- param rotation The rotation of the node in degrees.
-- @function [parent=#Node] setRotation
-- @param self
-- @param #float rotation
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Changes the scale factor on Z axis of this node
-- The Default value is 1.0 if you haven't changed it before.
-- param scaleZ The scale factor on Z axis.
-- warning The physics body doesn't support this.
-- @function [parent=#Node] setScaleZ
-- @param self
-- @param #float scaleZ
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the scale (y) of the node.
-- It is a scaling factor that multiplies the height of the node and its children.
-- param scaleY The scale factor on Y axis.
-- warning The physics body doesn't support this.
-- @function [parent=#Node] setScaleY
-- @param self
-- @param #float scaleY
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the scale (x) of the node.
-- It is a scaling factor that multiplies the width of the node and its children.
-- param scaleX The scale factor on X axis.
-- warning The physics body doesn't support this.
-- @function [parent=#Node] setScaleX
-- @param self
-- @param #float scaleX
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the X rotation (angle) of the node in degrees which performs a horizontal rotational skew.
-- The difference between `setRotationalSkew()` and `setSkew()` is that the first one simulate Flash's skew functionality,
-- while the second one uses the real skew function.
-- 0 is the default rotation angle.
-- Positive values rotate node clockwise, and negative values for anti-clockwise.
-- param rotationX The X rotation in degrees which performs a horizontal rotational skew.
-- warning The physics body doesn't support this.
-- js setRotationX
-- @function [parent=#Node] setRotationSkewX
-- @param self
-- @param #float rotationX
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Set the callback of event EnterTransitionDidFinish.
-- param callback A std::function callback.
-- @function [parent=#Node] setonEnterTransitionDidFinishCallback
-- @param self
-- @param #function callback
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Removes all components
-- @function [parent=#Node] removeAllComponents
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] _setLocalZOrder
-- @param self
-- @param #int z
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Modify the camera mask for current node.
-- If applyChildren is true, then it will modify the camera mask of its children recursively.
-- param mask A unsigned short bit for mask.
-- param applyChildren A boolean value to determine whether the mask bit should apply to its children or not.
-- @function [parent=#Node] setCameraMask
-- @param self
-- @param #unsigned short mask
-- @param #bool applyChildren
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns a tag that is used to identify the node easily.
-- return An integer that identifies the node.
-- Please use `getTag()` instead.
-- @function [parent=#Node] getTag
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- / @{/ @name GLProgram
-- Return the GLProgram (shader) currently used for this node.
-- return The GLProgram (shader) currently used for this node.
-- @function [parent=#Node] getGLProgram
-- @param self
-- @return GLProgram#GLProgram ret (return value: cc.GLProgram)
--------------------------------
-- Returns the world affine transform matrix. The matrix is in Pixels.
-- return transformation matrix, in pixels.
-- @function [parent=#Node] getNodeToWorldTransform
-- @param self
-- @return mat4_table#mat4_table ret (return value: mat4_table)
--------------------------------
-- Returns the position (X,Y,Z) in its parent's coordinate system.
-- return The position (X, Y, and Z) in its parent's coordinate system.
-- js NA
-- @function [parent=#Node] getPosition3D
-- @param self
-- @return vec3_table#vec3_table ret (return value: vec3_table)
--------------------------------
-- Removes a child from the container. It will also cleanup all running actions depending on the cleanup parameter.
-- param child The child node which will be removed.
-- param cleanup True if all running actions and callbacks on the child node will be cleanup, false otherwise.
-- @function [parent=#Node] removeChild
-- @param self
-- @param #cc.Node child
-- @param #bool cleanup
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Converts a Vec2 to world space coordinates. The result is in Points.
-- param nodePoint A given coordinate.
-- return A point in world space coordinates.
-- @function [parent=#Node] convertToWorldSpace
-- @param self
-- @param #vec2_table nodePoint
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Returns the Scene that contains the Node.
-- It returns `nullptr` if the node doesn't belong to any Scene.
-- This function recursively calls parent->getScene() until parent is a Scene object. The results are not cached. It is that the user caches the results in case this functions is being used inside a loop.
-- return The Scene that contains the node.
-- @function [parent=#Node] getScene
-- @param self
-- @return Scene#Scene ret (return value: cc.Scene)
--------------------------------
-- Get the event dispatcher of scene.
-- return The event dispatcher of scene.
-- @function [parent=#Node] getEventDispatcher
-- @param self
-- @return EventDispatcher#EventDispatcher ret (return value: cc.EventDispatcher)
--------------------------------
-- Changes the X skew angle of the node in degrees.
-- The difference between `setRotationalSkew()` and `setSkew()` is that the first one simulate Flash's skew functionality
-- while the second one uses the real skew function.
-- This angle describes the shear distortion in the X direction.
-- Thus, it is the angle between the Y coordinate and the left edge of the shape
-- The default skewX angle is 0. Positive values distort the node in a CW direction.
-- param skewX The X skew angle of the node in degrees.
-- warning The physics body doesn't support this.
-- @function [parent=#Node] setSkewX
-- @param self
-- @param #float skewX
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Set the GLProgramState for this node.
-- param glProgramState The GLProgramState for this node.
-- @function [parent=#Node] setGLProgramState
-- @param self
-- @param #cc.GLProgramState glProgramState
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Set the callback of event onEnter.
-- param callback A std::function callback.
-- @function [parent=#Node] setOnEnterCallback
-- @param self
-- @param #function callback
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Removes all actions from the running action list by its flags.
-- param flags A flag field that removes actions based on bitwise AND.
-- @function [parent=#Node] stopActionsByFlags
-- @param self
-- @param #unsigned int flags
-- @return Node#Node self (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] setNormalizedPosition
-- @param self
-- @param #vec2_table position
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Set the callback of event ExitTransitionDidStart.
-- param callback A std::function callback.
-- @function [parent=#Node] setonExitTransitionDidStartCallback
-- @param self
-- @param #function callback
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- convenience methods which take a Touch instead of Vec2.
-- param touch A given touch.
-- return A point in world space coordinates.
-- @function [parent=#Node] convertTouchToNodeSpace
-- @param self
-- @param #cc.Touch touch
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- @overload self, bool
-- @overload self
-- @function [parent=#Node] removeAllChildrenWithCleanup
-- @param self
-- @param #bool cleanup
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- @overload self, cc.Node
-- @overload self
-- @function [parent=#Node] getNodeToParentAffineTransform
-- @param self
-- @param #cc.Node ancestor
-- @return AffineTransform#AffineTransform ret (return value: cc.AffineTransform)
--------------------------------
-- Whether cascadeOpacity is enabled or not.
-- return A boolean value.
-- @function [parent=#Node] isCascadeOpacityEnabled
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Sets the parent node.
-- param parent A pointer to the parent node.
-- @function [parent=#Node] setParent
-- @param self
-- @param #cc.Node parent
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns a string that is used to identify the node.
-- return A string that identifies the node.
-- since v3.2
-- @function [parent=#Node] getName
-- @param self
-- @return string#string ret (return value: string)
--------------------------------
-- Resumes all scheduled selectors, actions and event listeners.
-- This method is called internally by onEnter.
-- @function [parent=#Node] resume
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the rotation (X,Y,Z) in degrees.
-- return The rotation of the node in 3d.
-- js NA
-- @function [parent=#Node] getRotation3D
-- @param self
-- @return vec3_table#vec3_table ret (return value: vec3_table)
--------------------------------
-- @overload self, cc.Node
-- @overload self
-- @function [parent=#Node] getNodeToParentTransform
-- @param self
-- @param #cc.Node ancestor
-- @return mat4_table#mat4_table ret (return value: mat4_table)
--------------------------------
-- converts a Touch (world coordinates) into a local coordinate. This method is AR (Anchor Relative).
-- param touch A given touch.
-- return A point in world space coordinates, anchor relative.
-- @function [parent=#Node] convertTouchToNodeSpaceAR
-- @param self
-- @param #cc.Touch touch
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Converts a Vec2 to node (local) space coordinates. The result is in Points.
-- param worldPoint A given coordinate.
-- return A point in node (local) space coordinates.
-- @function [parent=#Node] convertToNodeSpace
-- @param self
-- @param #vec2_table worldPoint
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Sets the position (x,y) using values between 0 and 1.
-- The positions in pixels is calculated like the following:
-- code pseudo code
-- void setNormalizedPosition(Vec2 pos) {
-- Size s = getParent()->getContentSize();
-- _position = pos * s;
-- }
-- endcode
-- param position The normalized position (x,y) of the node, using value between 0 and 1.
-- @function [parent=#Node] setPositionNormalized
-- @param self
-- @param #vec2_table position
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Pauses all scheduled selectors, actions and event listeners.
-- This method is called internally by onExit.
-- @function [parent=#Node] pause
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- If node opacity will modify the RGB color value, then you should override this method and return true.
-- return A boolean value, true indicates that opacity will modify color; false otherwise.
-- @function [parent=#Node] isOpacityModifyRGB
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- @overload self, float, float
-- @overload self, vec2_table
-- @function [parent=#Node] setPosition
-- @param self
-- @param #float x
-- @param #float y
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Removes an action from the running action list by its tag.
-- param tag A tag that indicates the action to be removed.
-- @function [parent=#Node] stopActionByTag
-- @param self
-- @param #int tag
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Reorders a child according to a new z value.
-- param child An already added child node. It MUST be already added.
-- param localZOrder Z order for drawing priority. Please refer to setLocalZOrder(int).
-- @function [parent=#Node] reorderChild
-- @param self
-- @param #cc.Node child
-- @param #int localZOrder
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Changes the Y skew angle of the node in degrees.
-- The difference between `setRotationalSkew()` and `setSkew()` is that the first one simulate Flash's skew functionality
-- while the second one uses the real skew function.
-- This angle describes the shear distortion in the Y direction.
-- Thus, it is the angle between the X coordinate and the bottom edge of the shape.
-- The default skewY angle is 0. Positive values distort the node in a CCW direction.
-- param skewY The Y skew angle of the node in degrees.
-- warning The physics body doesn't support this.
-- @function [parent=#Node] setSkewY
-- @param self
-- @param #float skewY
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the 'z' coordinate in the position. It is the OpenGL Z vertex value.
-- The OpenGL depth buffer and depth testing are disabled by default. You need to turn them on.
-- In order to use this property correctly.
-- `setPositionZ()` also sets the `setGlobalZValue()` with the positionZ as value.
-- see `setGlobalZValue()`
-- param positionZ OpenGL Z vertex of this node.
-- js setVertexZ
-- @function [parent=#Node] setPositionZ
-- @param self
-- @param #float positionZ
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the rotation (X,Y,Z) in degrees.
-- Useful for 3d rotations.
-- warning The physics body doesn't support this.
-- param rotation The rotation of the node in 3d.
-- js NA
-- @function [parent=#Node] setRotation3D
-- @param self
-- @param #vec3_table rotation
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Gets/Sets x or y coordinate individually for position.
-- These methods are used in Lua and Javascript Bindings
-- Sets the x coordinate of the node in its parent's coordinate system.
-- param x The x coordinate of the node.
-- @function [parent=#Node] setPositionX
-- @param self
-- @param #float x
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the transformation matrix manually.
-- param transform A given transformation matrix.
-- @function [parent=#Node] setNodeToParentTransform
-- @param self
-- @param #mat4_table transform
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the anchor point in percent.
-- see `setAnchorPoint(const Vec2&)`
-- return The anchor point of node.
-- @function [parent=#Node] getAnchorPoint
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Returns the numbers of actions that are running plus the ones that are schedule to run (actions in actionsToAdd and actions arrays).
-- Composable actions are counted as 1 action. Example:
-- If you are running 1 Sequence of 7 actions, it will return 1.
-- If you are running 7 Sequences of 2 actions, it will return 7.
-- return The number of actions that are running plus the ones that are schedule to run.
-- @function [parent=#Node] getNumberOfRunningActions
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- Calls children's updateTransform() method recursively.
-- This method is moved from Sprite, so it's no longer specific to Sprite.
-- As the result, you apply SpriteBatchNode's optimization on your customed Node.
-- e.g., `batchNode->addChild(myCustomNode)`, while you can only addChild(sprite) before.
-- @function [parent=#Node] updateTransform
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the shader program for this node
-- Since v2.0, each rendering node must set its shader program.
-- It should be set in initialize phase.
-- code
-- node->setGLrProgram(GLProgramCache::getInstance()->getProgram(GLProgram::SHADER_NAME_POSITION_TEXTURE_COLOR));
-- endcode
-- param glprogram The shader program.
-- @function [parent=#Node] setGLProgram
-- @param self
-- @param #cc.GLProgram glprogram
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Determines if the node is visible.
-- see `setVisible(bool)`
-- return true if the node is visible, false if the node is hidden.
-- @function [parent=#Node] isVisible
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Returns the amount of children.
-- return The amount of children.
-- @function [parent=#Node] getChildrenCount
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- Converts a Vec2 to node (local) space coordinates. The result is in Points.
-- treating the returned/received node point as anchor relative.
-- param worldPoint A given coordinate.
-- return A point in node (local) space coordinates, anchor relative.
-- @function [parent=#Node] convertToNodeSpaceAR
-- @param self
-- @param #vec2_table worldPoint
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Adds a component.
-- param component A given component.
-- return True if added success.
-- @function [parent=#Node] addComponent
-- @param self
-- @param #cc.Component component
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Executes an action, and returns the action that is executed.
-- This node becomes the action's target. Refer to Action::getTarget().
-- warning Actions don't retain their target.
-- param action An Action pointer.
-- @function [parent=#Node] runAction
-- @param self
-- @param #cc.Action action
-- @return Action#Action ret (return value: cc.Action)
--------------------------------
-- @overload self
-- @overload self, cc.Renderer, mat4_table, unsigned int
-- @function [parent=#Node] visit
-- @param self
-- @param #cc.Renderer renderer
-- @param #mat4_table parentTransform
-- @param #unsigned int parentFlags
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the rotation of the node in degrees.
-- see `setRotation(float)`
-- return The rotation of the node in degrees.
-- @function [parent=#Node] getRotation
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
--
-- @function [parent=#Node] getPhysicsBody
-- @param self
-- @return PhysicsBody#PhysicsBody ret (return value: cc.PhysicsBody)
--------------------------------
-- Returns the anchorPoint in absolute pixels.
-- warning You can only read it. If you wish to modify it, use anchorPoint instead.
-- see `getAnchorPoint()`
-- return The anchor point in absolute pixels.
-- @function [parent=#Node] getAnchorPointInPoints
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter.
-- param name A string that identifies a child node.
-- param cleanup True if all running actions and callbacks on the child node will be cleanup, false otherwise.
-- @function [parent=#Node] removeChildByName
-- @param self
-- @param #string name
-- @param #bool cleanup
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Return the GLProgramState currently used for this node.
-- return The GLProgramState currently used for this node.
-- @function [parent=#Node] getGLProgramState
-- @param self
-- @return GLProgramState#GLProgramState ret (return value: cc.GLProgramState)
--------------------------------
-- Sets a Scheduler object that is used to schedule all "updates" and timers.
-- warning If you set a new Scheduler, then previously created timers/update are going to be removed.
-- param scheduler A Scheduler object that is used to schedule all "update" and timers.
-- @function [parent=#Node] setScheduler
-- @param self
-- @param #cc.Scheduler scheduler
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Stops and removes all actions from the running action list .
-- @function [parent=#Node] stopAllActions
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the X skew angle of the node in degrees.
-- see `setSkewX(float)`
-- return The X skew angle of the node in degrees.
-- @function [parent=#Node] getSkewX
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Returns the Y skew angle of the node in degrees.
-- see `setSkewY(float)`
-- return The Y skew angle of the node in degrees.
-- @function [parent=#Node] getSkewY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Query node's displayed color.
-- return A Color3B color value.
-- @function [parent=#Node] getDisplayedColor
-- @param self
-- @return color3b_table#color3b_table ret (return value: color3b_table)
--------------------------------
-- Gets an action from the running action list by its tag.
-- see `setTag(int)`, `getTag()`.
-- return The action object with the given tag.
-- @function [parent=#Node] getActionByTag
-- @param self
-- @param #int tag
-- @return Action#Action ret (return value: cc.Action)
--------------------------------
-- Changes the name that is used to identify the node easily.
-- param name A string that identifies the node.
-- since v3.2
-- @function [parent=#Node] setName
-- @param self
-- @param #string name
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Update method will be called automatically every frame if "scheduleUpdate" is called, and the node is "live".
-- param delta In seconds.
-- @function [parent=#Node] update
-- @param self
-- @param #float delta
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Return the node's display opacity.
-- The difference between opacity and displayedOpacity is:
-- The displayedOpacity is what's the final rendering opacity of node.
-- return A GLubyte value.
-- @function [parent=#Node] getDisplayedOpacity
-- @param self
-- @return unsigned char#unsigned char ret (return value: unsigned char)
--------------------------------
-- Gets the local Z order of this node.
-- see `setLocalZOrder(int)`
-- return The local (relative to its siblings) Z order.
-- @function [parent=#Node] getLocalZOrder
-- @param self
-- @return int#int ret (return value: int)
--------------------------------
-- @overload self
-- @overload self
-- @function [parent=#Node] getScheduler
-- @param self
-- @return Scheduler#Scheduler ret (return value: cc.Scheduler)
--------------------------------
--
-- @function [parent=#Node] getParentToNodeAffineTransform
-- @param self
-- @return AffineTransform#AffineTransform ret (return value: cc.AffineTransform)
--------------------------------
-- Returns the normalized position.
-- return The normalized position.
-- @function [parent=#Node] getPositionNormalized
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Change the color of node.
-- param color A Color3B color value.
-- @function [parent=#Node] setColor
-- @param self
-- @param #color3b_table color
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns whether or not the node is "running".
-- If the node is running it will accept event callbacks like onEnter(), onExit(), update().
-- return Whether or not the node is running.
-- @function [parent=#Node] isRunning
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- @overload self
-- @overload self
-- @function [parent=#Node] getParent
-- @param self
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Gets position Z coordinate of this node.
-- see setPositionZ(float)
-- return The position Z coordinate of this node.
-- js getVertexZ
-- @function [parent=#Node] getPositionZ
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Gets the y coordinate of the node in its parent's coordinate system.
-- return The y coordinate of the node.
-- @function [parent=#Node] getPositionY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Gets the x coordinate of the node in its parent's coordinate system.
-- return The x coordinate of the node.
-- @function [parent=#Node] getPositionX
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter.
-- param tag An integer number that identifies a child node.
-- param cleanup True if all running actions and callbacks on the child node will be cleanup, false otherwise.
-- Please use `removeChildByName` instead.
-- @function [parent=#Node] removeChildByTag
-- @param self
-- @param #int tag
-- @param #bool cleanup
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the y coordinate of the node in its parent's coordinate system.
-- param y The y coordinate of the node.
-- @function [parent=#Node] setPositionY
-- @param self
-- @param #float y
-- @return Node#Node self (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] getNodeToWorldAffineTransform
-- @param self
-- @return AffineTransform#AffineTransform ret (return value: cc.AffineTransform)
--------------------------------
-- Update node's displayed color with its parent color.
-- param parentColor A Color3B color value.
-- @function [parent=#Node] updateDisplayedColor
-- @param self
-- @param #color3b_table parentColor
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets whether the node is visible.
-- The default value is true, a node is default to visible.
-- param visible true if the node is visible, false if the node is hidden.
-- @function [parent=#Node] setVisible
-- @param self
-- @param #bool visible
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the matrix that transform parent's space coordinates to the node's (local) space coordinates.
-- The matrix is in Pixels.
-- return The transformation matrix.
-- @function [parent=#Node] getParentToNodeTransform
-- @param self
-- @return mat4_table#mat4_table ret (return value: mat4_table)
--------------------------------
-- Checks whether a lambda function is scheduled.
-- param key key of the callback
-- return Whether the lambda function selector is scheduled.
-- js NA
-- lua NA
-- @function [parent=#Node] isScheduled
-- @param self
-- @param #string key
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Defines the order in which the nodes are renderer.
-- Nodes that have a Global Z Order lower, are renderer first.
-- In case two or more nodes have the same Global Z Order, the order is not guaranteed.
-- The only exception if the Nodes have a Global Z Order == 0. In that case, the Scene Graph order is used.
-- By default, all nodes have a Global Z Order = 0. That means that by default, the Scene Graph order is used to render the nodes.
-- Global Z Order is useful when you need to render nodes in an order different than the Scene Graph order.
-- Limitations: Global Z Order can't be used by Nodes that have SpriteBatchNode as one of their ancestors.
-- And if ClippingNode is one of the ancestors, then "global Z order" will be relative to the ClippingNode.
-- see `setLocalZOrder()`
-- see `setVertexZ()`
-- since v3.0
-- param globalZOrder The global Z order value.
-- @function [parent=#Node] setGlobalZOrder
-- @param self
-- @param #float globalZOrder
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- @overload self, float, float
-- @overload self, float
-- @function [parent=#Node] setScale
-- @param self
-- @param #float scaleX
-- @param #float scaleY
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Gets a child from the container with its tag.
-- param tag An identifier to find the child node.
-- return a Node object whose tag equals to the input parameter.
-- Please use `getChildByName()` instead.
-- @function [parent=#Node] getChildByTag
-- @param self
-- @param #int tag
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Returns the scale factor on Z axis of this node
-- see `setScaleZ(float)`
-- return The scale factor on Z axis.
-- @function [parent=#Node] getScaleZ
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Returns the scale factor on Y axis of this node
-- see `setScaleY(float)`
-- return The scale factor on Y axis.
-- @function [parent=#Node] getScaleY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Returns the scale factor on X axis of this node
-- see setScaleX(float)
-- return The scale factor on X axis.
-- @function [parent=#Node] getScaleX
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- LocalZOrder is the 'key' used to sort the node relative to its siblings.
-- The Node's parent will sort all its children based on the LocalZOrder value.
-- If two nodes have the same LocalZOrder, then the node that was added first to the children's array will be in front of the other node in the array.
-- Also, the Scene Graph is traversed using the "In-Order" tree traversal algorithm ( http:en.wikipedia.org/wiki/Tree_traversal#In-order )
-- And Nodes that have LocalZOrder values < 0 are the "left" subtree
-- While Nodes with LocalZOrder >=0 are the "right" subtree.
-- see `setGlobalZOrder`
-- see `setVertexZ`
-- param localZOrder The local Z order value.
-- @function [parent=#Node] setLocalZOrder
-- @param self
-- @param #int localZOrder
-- @return Node#Node self (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] getWorldToNodeAffineTransform
-- @param self
-- @return AffineTransform#AffineTransform ret (return value: cc.AffineTransform)
--------------------------------
-- If you want node's color affect the children node's color, then set it to true.
-- Otherwise, set it to false.
-- param cascadeColorEnabled A boolean value.
-- @function [parent=#Node] setCascadeColorEnabled
-- @param self
-- @param #bool cascadeColorEnabled
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Change node opacity.
-- param opacity A GLubyte opacity value.
-- @function [parent=#Node] setOpacity
-- @param self
-- @param #unsigned char opacity
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Stops all running actions and schedulers
-- @function [parent=#Node] cleanup
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- / @{/ @name component functions
-- Gets a component by its name.
-- param name A given name of component.
-- return The Component by name.
-- @function [parent=#Node] getComponent
-- @param self
-- @param #string name
-- @return Component#Component ret (return value: cc.Component)
--------------------------------
-- Returns the untransformed size of the node.
-- see `setContentSize(const Size&)`
-- return The untransformed size of the node.
-- @function [parent=#Node] getContentSize
-- @param self
-- @return size_table#size_table ret (return value: size_table)
--------------------------------
-- Removes all actions from the running action list by its tag.
-- param tag A tag that indicates the action to be removed.
-- @function [parent=#Node] stopAllActionsByTag
-- @param self
-- @param #int tag
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Query node's color value.
-- return A Color3B color value.
-- @function [parent=#Node] getColor
-- @param self
-- @return color3b_table#color3b_table ret (return value: color3b_table)
--------------------------------
-- Returns an AABB (axis-aligned bounding-box) in its parent's coordinate system.
-- return An AABB (axis-aligned bounding-box) in its parent's coordinate system
-- @function [parent=#Node] getBoundingBox
-- @param self
-- @return rect_table#rect_table ret (return value: rect_table)
--------------------------------
-- Sets whether the anchor point will be (0,0) when you position this node.
-- This is an internal method, only used by Layer and Scene. Don't call it outside framework.
-- The default value is false, while in Layer and Scene are true.
-- param ignore true if anchor point will be (0,0) when you position this node.
-- @function [parent=#Node] setIgnoreAnchorPointForPosition
-- @param self
-- @param #bool ignore
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Set event dispatcher for scene.
-- param dispatcher The event dispatcher of scene.
-- @function [parent=#Node] setEventDispatcher
-- @param self
-- @param #cc.EventDispatcher dispatcher
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the Node's Global Z Order.
-- see `setGlobalZOrder(int)`
-- return The node's global Z order
-- @function [parent=#Node] getGlobalZOrder
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- @overload self
-- @overload self, cc.Renderer, mat4_table, unsigned int
-- @function [parent=#Node] draw
-- @param self
-- @param #cc.Renderer renderer
-- @param #mat4_table transform
-- @param #unsigned int flags
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns a user assigned Object.
-- Similar to UserData, but instead of holding a void* it holds an object.
-- The UserObject will be retained once in this method,
-- and the previous UserObject (if existed) will be released.
-- The UserObject will be released in Node's destructor.
-- param userObject A user assigned Object.
-- @function [parent=#Node] setUserObject
-- @param self
-- @param #cc.Ref userObject
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- @overload self, bool
-- @overload self
-- @function [parent=#Node] removeFromParentAndCleanup
-- @param self
-- @param #bool cleanup
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Sets the position (X, Y, and Z) in its parent's coordinate system.
-- param position The position (X, Y, and Z) in its parent's coordinate system.
-- js NA
-- @function [parent=#Node] setPosition3D
-- @param self
-- @param #vec3_table position
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the numbers of actions that are running plus the ones that are
-- schedule to run (actions in actionsToAdd and actions arrays) with a
-- specific tag.
-- Composable actions are counted as 1 action. Example:
-- If you are running 1 Sequence of 7 actions, it will return 1.
-- If you are running 7 Sequences of 2 actions, it will return 7.
-- param tag The tag that will be searched.
-- return The number of actions that are running plus the
-- ones that are schedule to run with specific tag.
-- @function [parent=#Node] getNumberOfRunningActionsByTag
-- @param self
-- @param #int tag
-- @return int#int ret (return value: int)
--------------------------------
-- Sorts the children array once before drawing, instead of every time when a child is added or reordered.
-- This approach can improves the performance massively.
-- note Don't call this manually unless a child added needs to be removed in the same frame.
-- @function [parent=#Node] sortAllChildren
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Returns the inverse world affine transform matrix. The matrix is in Pixels.
-- return The transformation matrix.
-- @function [parent=#Node] getWorldToNodeTransform
-- @param self
-- @return mat4_table#mat4_table ret (return value: mat4_table)
--------------------------------
-- Gets the scale factor of the node, when X and Y have the same scale factor.
-- warning Assert when `_scaleX != _scaleY`
-- see setScale(float)
-- return The scale factor of the node.
-- @function [parent=#Node] getScale
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Return the node's opacity.
-- return A GLubyte value.
-- @function [parent=#Node] getOpacity
-- @param self
-- @return unsigned char#unsigned char ret (return value: unsigned char)
--------------------------------
-- !!! ONLY FOR INTERNAL USE
-- Sets the arrival order when this node has a same ZOrder with other children.
-- A node which called addChild subsequently will take a larger arrival order,
-- If two children have the same Z order, the child with larger arrival order will be drawn later.
-- warning This method is used internally for localZOrder sorting, don't change this manually
-- param orderOfArrival The arrival order.
-- @function [parent=#Node] updateOrderOfArrival
-- @param self
-- @return Node#Node self (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] getNormalizedPosition
-- @param self
-- @return vec2_table#vec2_table ret (return value: vec2_table)
--------------------------------
-- Gets the X rotation (angle) of the node in degrees which performs a horizontal rotation skew.
-- see `setRotationSkewX(float)`
-- return The X rotation in degrees.
-- js getRotationX
-- @function [parent=#Node] getRotationSkewX
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Gets the Y rotation (angle) of the node in degrees which performs a vertical rotational skew.
-- see `setRotationSkewY(float)`
-- return The Y rotation in degrees.
-- js getRotationY
-- @function [parent=#Node] getRotationSkewY
-- @param self
-- @return float#float ret (return value: float)
--------------------------------
-- Changes the tag that is used to identify the node easily.
-- Please refer to getTag for the sample code.
-- param tag A integer that identifies the node.
-- Please use `setName()` instead.
-- @function [parent=#Node] setTag
-- @param self
-- @param #int tag
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- Query whether cascadeColor is enabled or not.
-- return Whether cascadeColor is enabled or not.
-- @function [parent=#Node] isCascadeColorEnabled
-- @param self
-- @return bool#bool ret (return value: bool)
--------------------------------
-- Stops and removes an action from the running action list.
-- param action The action object to be removed.
-- @function [parent=#Node] stopAction
-- @param self
-- @param #cc.Action action
-- @return Node#Node self (return value: cc.Node)
--------------------------------
-- @overload self
-- @overload self
-- @function [parent=#Node] getActionManager
-- @param self
-- @return ActionManager#ActionManager ret (return value: cc.ActionManager)
--------------------------------
-- Allocates and initializes a node.
-- return A initialized node which is marked as "autorelease".
-- @function [parent=#Node] create
-- @param self
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
--
-- @function [parent=#Node] Node
-- @param self
-- @return Node#Node self (return value: cc.Node)
return nil