axmol/cocos/scripting/lua-bindings/auto/api/ProtectedNode.lua

139 lines
5.4 KiB
Lua
Raw Normal View History

--------------------------------
-- @module ProtectedNode
-- @extend Node
-- @parent_module cc
--------------------------------
-- @overload self, cc.Node, int
-- @overload self, cc.Node
-- @overload self, cc.Node, int, int
-- @function [parent=#ProtectedNode] addProtectedChild
-- @param self
-- @param #cc.Node child
-- @param #int localZOrder
-- @param #int tag
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
--
-- @function [parent=#ProtectedNode] disableCascadeColor
-- @param self
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Removes a child from the container by tag value. It will also cleanup all running actions depending on the cleanup parameter.<br>
-- param tag An interger number that identifies a child node.<br>
-- param cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.
-- @function [parent=#ProtectedNode] removeProtectedChildByTag
-- @param self
-- @param #int tag
-- @param #bool cleanup
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Reorders a child according to a new z value.<br>
-- param child An already added child node. It MUST be already added.<br>
-- param localZOrder Z order for drawing priority. Please refer to setLocalZOrder(int)
-- @function [parent=#ProtectedNode] reorderProtectedChild
-- @param self
-- @param #cc.Node child
-- @param #int localZOrder
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Removes all children from the container, and do a cleanup to all running actions depending on the cleanup parameter.<br>
-- param cleanup true if all running actions on all children nodes should be cleanup, false oterwise.<br>
-- js removeAllChildren<br>
-- lua removeAllChildren
-- @function [parent=#ProtectedNode] removeAllProtectedChildrenWithCleanup
-- @param self
-- @param #bool cleanup
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
--
-- @function [parent=#ProtectedNode] disableCascadeOpacity
-- @param self
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Sorts the children array once before drawing, instead of every time when a child is added or reordered.<br>
-- This appraoch can improves the performance massively.<br>
-- note Don't call this manually unless a child added needs to be removed in the same frame
-- @function [parent=#ProtectedNode] sortAllProtectedChildren
-- @param self
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Gets a child from the container with its tag.<br>
-- param tag An identifier to find the child node.<br>
-- return a Node object whose tag equals to the input parameter.
-- @function [parent=#ProtectedNode] getProtectedChildByTag
-- @param self
-- @param #int tag
-- @return Node#Node ret (return value: cc.Node)
--------------------------------
-- Removes a child from the container. It will also cleanup all running actions depending on the cleanup parameter.<br>
-- param child The child node which will be removed.<br>
-- param cleanup true if all running actions and callbacks on the child node will be cleanup, false otherwise.
-- @function [parent=#ProtectedNode] removeProtectedChild
-- @param self
-- @param #cc.Node child
-- @param #bool cleanup
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Removes all children from the container with a cleanup.<br>
-- see `removeAllChildrenWithCleanup(bool)`.
-- @function [parent=#ProtectedNode] removeAllProtectedChildren
-- @param self
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- Creates a ProtectedNode with no argument.<br>
-- return A instance of ProtectedNode.
-- @function [parent=#ProtectedNode] create
-- @param self
-- @return ProtectedNode#ProtectedNode ret (return value: cc.ProtectedNode)
--------------------------------
--
-- @function [parent=#ProtectedNode] setCameraMask
-- @param self
-- @param #unsigned short mask
-- @param #bool applyChildren
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
-- / @} end of Children and Parent
-- @function [parent=#ProtectedNode] visit
-- @param self
-- @param #cc.Renderer renderer
-- @param #mat4_table parentTransform
-- @param #unsigned int parentFlags
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
--
-- @function [parent=#ProtectedNode] updateDisplayedOpacity
-- @param self
-- @param #unsigned char parentOpacity
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
--
-- @function [parent=#ProtectedNode] updateDisplayedColor
-- @param self
-- @param #color3b_table parentColor
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
--------------------------------
--
-- @function [parent=#ProtectedNode] cleanup
-- @param self
-- @return ProtectedNode#ProtectedNode self (return value: cc.ProtectedNode)
return nil