Node

描述：

  用于构建游戏场景树的层次结构的类。

类对象：Node Class。

继承自：Object。

order

类型： 成员变量。

描述：

  在同级子节点列表中的顺序。

签名：

order: integer

angle

类型： 成员变量。

描述：

  节点的旋转角度，以度为单位。

签名：

angle: number

angleX

类型： 成员变量。

描述：

  节点的 X 轴旋转角度，以度为单位。

签名：

angleX: number

angleY

类型： 成员变量。

描述：

  节点的 Y 轴旋转角度，以度为单位。

签名：

angleY: number

scaleX

类型： 成员变量。

描述：

  节点的 X 轴缩放系数。

签名：

scaleX: number

scaleY

类型： 成员变量。

描述：

  节点的 Y 轴缩放系数。

签名：

scaleY: number

x

类型： 成员变量。

描述：

  节点的 X 轴位置。

签名：

x: number

y

类型： 成员变量。

描述：

  节点的 Y 轴位置。

签名：

y: number

z

类型： 成员变量。

描述：

  节点的 Z 轴位置。

签名：

z: number

position

类型： 成员变量。

描述：

  以二维向量对象表示的节点位置。

签名：

position: Vec2

skewX

类型： 成员变量。

描述：

  节点的 X 轴倾斜角度，以度为单位。

签名：

skewX: number

skewY

类型： 成员变量。

描述：

  节点的 Y 轴倾斜角度，以度为单位。

签名：

skewY: number

visible

类型： 成员变量。

描述：

  节点是否可见。

签名：

visible: boolean

anchor

类型： 成员变量。

描述：

  以 Vec2 对象表示的节点锚点。

签名：

anchor: Vec2

width

类型： 成员变量。

描述：

  节点的宽度。

签名：

width: number

height

类型： 成员变量。

描述：

  节点的高度。

签名：

height: number

size

类型： 成员变量。

描述：

  以Size对象表示的节点大小。

签名：

size: Size

tag

类型： 成员变量。

描述：

  以字符串形式表示的节点标签。

签名：

tag: string

opacity

类型： 成员变量。

描述：

  节点的不透明度，取值范围为 0 到 1.0。

签名：

opacity: number

color

类型： 成员变量。

描述：

  以Color对象表示的节点颜色。

签名：

color: Color

color3

类型： 成员变量。

描述：

  以Color3对象表示的节点颜色。

签名：

color3: Color3

passOpacity

类型： 成员变量。

描述：

  是否传递不透明度值给子节点。

签名：

passOpacity: boolean

passColor3

类型： 成员变量。

描述：

  是否传递颜色值给子节点。

签名：

passColor3: boolean

transformTarget

类型： 成员变量。

描述：

  用于继承矩阵变换的目标节点。

签名：

transformTarget: Node

scheduler

类型： 成员变量。

描述：

  用于调度每帧逻辑更新的调度器。

签名：

scheduler: Scheduler

hasChildren

类型： 只读成员变量。

描述：

  是否有子节点。

签名：

const hasChildren: boolean

children

类型： 只读成员变量。

描述：

  子节点的列表，可能为nil。

签名：

const children: Array

parent

类型： 只读成员变量。

描述：

  节点的父节点。

签名：

const parent: Node

running

类型： 只读成员变量。

描述：

  节点是否在场景树中挂载运行。

签名：

const running: boolean

scheduled

类型： 只读成员变量。

描述：

  节点是否在调度更新函数或协程。

签名：

const scheduled: boolean

actionCount

类型： 只读成员变量。

描述：

  节点上当前正在运行的动作数量。

签名：

const actionCount: integer

data

类型： 只读成员变量。

描述：

  在节点上存储管理的附加数据。

签名：

const data: Dictionary

touchEnabled

类型： 成员变量。

描述：

  是否启用触摸事件。

签名：

touchEnabled: boolean

swallowTouches

类型： 成员变量。

描述：

  节点是否独占触摸事件。

签名：

swallowTouches: boolean

swallowMouseWheel

类型： 成员变量。

描述：

  节点是否独占鼠标滚轮事件。

签名：

swallowMouseWheel: boolean

keyboardEnabled

类型： 成员变量。

描述：

  是否启用键盘事件。

签名：

keyboardEnabled: boolean

controllerEnabled

类型： 成员变量。

描述：

  是否启用游戏手柄事件。

签名：

controllerEnabled: boolean

renderGroup

类型： 成员变量。

描述：

  是否将所有层级的子节点按分组编号做分组渲染。

签名：

renderGroup: boolean

showDebug

类型： 成员变量。

描述：

  是否显示节点的调试信息。

签名：

showDebug: boolean

renderOrder

类型： 成员变量。

描述：

  用于分组渲染的分组顺序编号。节点的渲染顺序编号越小，渲染就越靠前。

签名：

renderOrder: integer

addChild

类型： 函数。

描述：

  给当前节点添加子节点。

签名：

addChild: function(
		self: Node,
		child: Node,
		order?: integer --[[0]],
		tag?: string --[[""]]
	)

参数：

参数名	类型	描述
child	Node	要添加的子节点。
order	integer	[可选] 子节点的绘制顺序。默认为0。
tag	string	[可选] 子节点的标签。默认为空字符串。

addTo

类型： 函数。

描述：

  将当前节点添加到父节点

签名：

addTo: function(
		self: Node,
		parent: Node,
		order?: integer --[[0]],
		tag?: string --[[""]]
	): Node

参数：

参数名	类型	描述
parent	Node	要添加当前节点的父节点。
order	integer	[可选] 当前节点的绘制顺序。默认为0。
tag	string	[可选] 当前节点的标签。默认为空字符串。

返回值：

返回类型	描述
Node	当前节点，用于级连调用。

removeChild

类型： 函数。

描述：

  从当前节点中移除一个子节点。

签名：

removeChild: function(
		self: Node,
		child: Node,
		cleanup?: boolean --[[true]]
	)

参数：

参数名	类型	描述
child	Node	要移除的子节点。
cleanup	boolean	[可选] 是否清理子节点。默认为 true。

removeChildByTag

类型： 函数。

描述：

  通过标签从当前节点中移除一个子节点。

签名：

removeChildByTag: function(
		self: Node,
		tag: string,
		cleanup?: boolean --[[true]]
	)

参数：

参数名	类型	描述
tag	string	要移除的子节点的标签。
cleanup	boolean	[可选] 是否清理子节点。默认为 true。

removeAllChildren

类型： 函数。

描述：

  从当前节点中移除所有子节点。

签名：

removeAllChildren: function(
		self: Node,
		cleanup?: boolean --[[true]]
	)

参数：

参数名	类型	描述
cleanup	boolean	[可选] 是否清理子节点。默认为 true。

removeFromParent

类型： 函数。

描述：

  从其父节点中移除当前节点。

签名：

removeFromParent: function(
		self: Node,
		cleanup?: boolean --[[true]]
	)

参数：

参数名	类型	描述
cleanup	boolean	[可选] 是否清理当前节点。默认为 true。

moveToParent

类型： 函数。

描述：

  将当前节点移动到一个新的父节点中，而不触发节点进出场景树的事件。

签名：

moveToParent: function(self: Node, parent: Node)

参数：

参数名	类型	描述
parent	Node	要将当前节点移动到的新父节点。

cleanup

类型： 函数。

描述：

  清理当前节点上的所有资源。

签名：

cleanup: function(self: Node)

getChildByTag

类型： 函数。

描述：

  通过标签获取子节点。

签名：

getChildByTag: function(self: Node, tag: string): Node

参数：

参数名	类型	描述
tag	string	要获取的子节点的标签。

返回值：

返回类型	描述
Node	子节点，如果未找到则返回nil。

schedule

类型： 函数。

描述：

  调度一个主更新函数在每一帧运行。重复调用会覆盖被调度的主更新函数或协程任务。

签名：

schedule: function(self: Node, func: function(number): boolean)

参数：

参数名	类型	描述
func	function	要被调度的主更新函数，返回true停止运行。

schedule

类型： 函数。

描述：

  调度执行一个主协程任务。重复调用会覆盖被调度的主更新函数或协程任务。

签名：

schedule: function(self: Node, job: Routine.Job)

参数：

参数名	类型	描述
job	Routine.Job	要运行的主协程，用return true或coroutine.yield(true)停止运行。

unschedule

类型： 函数。

描述：

  停止调度的每帧运行的主更新函数或协程任务。

签名：

unschedule: function(self: Node)

once

类型： 函数。

描述：

  调度一个函数，该函数会在协程中运行一次。调用该函数会覆盖被调度的主更新函数或协程任务。

签名：

once: function(self: Node, func: function())

参数：

参数名	类型	描述
func	function	要在协程运行一次的函数。

loop

类型： 函数。

描述：

  调度一个函数，该函数会在协程中循环执行。调用该函数会覆盖被调度的主更新函数或协程任务。

签名：

loop: function(self: Node, func: function(): boolean)

参数：

参数名	类型	描述
func	function	要在循环执行的函数，返回true以停止。

convertToNodeSpace

类型： 函数。

描述：

  将世界空间中的点坐标转换为节点空间的点坐标。

签名：

convertToNodeSpace: function(self: Node, worldPoint: Vec2): Vec2

参数：

参数名	类型	描述
worldPoint	Vec2	要转换的点。

返回值：

返回类型	描述
Vec2	转换后的点。

convertToNodeSpace

类型： 函数。

描述：

  将世界空间中的点坐标转换为节点空间的点坐标。

签名：

convertToNodeSpace: function(self: Node, worldPoint: Vec2, z: number): Vec2, number

参数：

参数名	类型	描述
worldPoint	Vec2	要转换的点。
z	number	点的 z 坐标。

返回值：

返回类型	描述
Vec2	转换后的点。
number	转换后的点的 z 坐标。

convertToWorldSpace

类型： 函数。

描述：

  将节点空间中的点坐标转换为世界空间坐标。

签名：

convertToWorldSpace: function(self: Node, nodePoint: Vec2): Vec2

参数：

参数名	类型	描述
nodePoint	Vec2	节点空间中的点。

返回值：

返回类型	描述
Vec2	转换后的世界空间中的点。

convertToWorldSpace

类型： 函数。

描述：

  将节点空间中的点坐标转换为世界空间坐标。

签名：

convertToWorldSpace: function(self: Node, nodePoint: Vec2, z: number): Vec2, number

参数：

参数名	类型	描述
nodePoint	Vec2	节点空间中的点。
z	number	节点空间中的 z 坐标。

返回值：

返回类型	描述
Vec2	转换后的世界空间中的点。
number	转换后的世界空间中 z 坐标。

convertToWindowSpace

类型： 函数。

描述：

  将节点空间中的点坐标转换为操作系统窗口空间坐标。

签名：

convertToWindowSpace: function(self: Node, nodePoint: Vec2, callback: function(Vec2))

参数：

参数名	类型	描述
nodePoint	Vec2	节点空间中的点。
callback	function	接收转换后的操作系统窗口空间中的点点坐标的回调函数。

eachChild

类型： 函数。

描述：

  对该节点的每个子节点调用给定的函数。在迭代过程中，子节点不能被添加或删除。

签名：

eachChild: function(self: Node, func: function(Node): boolean): boolean

参数：

参数名	类型	描述
func	function	对每个子节点要调用的函数。该函数应返回一个布尔值，指示是否继续迭代。返回 true 以停止迭代。

返回值：

返回类型	描述
boolean	如果已访问所有子节点，则为false；如果函数中断了迭代，则为true。

traverse

类型： 函数。

描述：

  从此节点开始遍历场景树结构，并对每个访问的节点调用给定的函数。 未开启TraverseEnabled标志的节点不会被访问。在迭代过程中，子节点不能被添加或删除。

签名：

traverse: function(self: Node, func: function(Node): boolean): boolean

参数：

参数名	类型	描述
func	function	对于每个被访问的节点调用的函数。该函数应返回一个布尔值，指示是否继续遍历。返回true停止迭代。

返回值：

返回类型	描述
boolean	如果访问了所有节点，则为false，如果函数中断了遍历，则为true。

traverseAll

类型： 函数。

描述：

  从此节点开始遍历整个节点层次结构，并对每个访问的节点调用给定的函数。 未开启TraverseEnabled标志的节点也会被访问。在迭代过程中，子节点不能被添加或删除。

签名：

traverseAll: function(self: Node, func: function(Node): boolean): boolean

参数：

参数名	类型	描述
func	function	对于每个访问的节点调用的函数。该函数应返回一个布尔值，指示是否继续遍历。

返回值：

返回类型	描述
boolean	如果访问了所有节点，则为true，如果函数中断了遍历，则为false。

runAction

类型： 函数。

描述：

  在此节点上执行给定的动作对象。

签名：

runAction: function(self: Node, action: Action, loop?: boolean): number

参数：

参数名	类型	描述
action	Action	要执行的动作对象。
loop	boolean	[可选] 是否循环执行动作。默认为 false。

返回值：

返回类型	描述
number	新执行的动作的持续时间，以秒为单位。

runAction

类型： 函数。

描述：

  在此节点上执行由动作定义对象定义的动作。

签名：

runAction: function(self: Node, actionDef: ActionDef, loop?: boolean): number

参数：

参数名	类型	描述
actionDef	ActionDef	要运行的动作定义。
loop	boolean	[可选] 是否循环执行动作。默认为 false。

返回值：

返回类型	描述
number	新执行的动作的持续时间，以秒为单位。

stopAllActions

类型： 函数。

描述：

  停止在此节点上运行的所有动作。

签名：

stopAllActions: function(self: Node)

perform

类型： 函数。

描述：

  立即停止所有现有动作，并开始执行一个新动作。

签名：

perform: function(self: Node, action: Action, loop?: boolean): number

参数：

参数名	类型	描述
action	Action	要执行的动作。
loop	boolean	[可选] 是否循环执行动作。默认为 false。

返回值：

返回类型	描述
number	新执行的动作的持续时间，以秒为单位。

perform

类型： 函数。

描述：

  立即停止所有现有动作，并通过动作定义对象开始执行一个新动作。

签名：

perform: function(self: Node, actionDef: ActionDef, loop?: boolean): number

参数：

参数名	类型	描述
actionDef	ActionDef	要执行的动作定义。
loop	boolean	[可选] 是否循环执行动作。默认为 false。

返回值：

返回类型	描述
number	新执行的动作的持续时间，以秒为单位。

stopAction

类型： 函数。

描述：

  停止在此节点上运行的某个动作。

签名：

stopAction: function(self: Node, action: Action)

参数：

参数名	类型	描述
action	Action	要停止的动作。

alignItemsVertically

类型： 函数。

描述：

  垂直对齐该节点的所有子节点。

签名：

alignItemsVertically: function(
		self: Node,
		padding?: number --[[10]]
	): Size

参数：

参数名	类型	描述
padding	number	[可选] 子节点之间的间距。默认值为10。

返回值：

返回类型	描述
Size	对齐后的子节点区域的大小。

alignItemsVertically

类型： 函数。

描述：

  使用给定的范围和间距在节点内垂直对齐所有子节点。

签名：

alignItemsVertically: function(
		self: Node,
		size: Size,
		padding?: number --[[10]]
	): Size

参数：

参数名	类型	描述
size	Size	用于对齐排布的范围。
padding	number	[可选] 子节点之间的间距（默认值为10）。

返回值：

返回类型	描述
Size	对齐后的节点区域大小。

alignItemsHorizontally

类型： 函数。

描述：

  使用给定的间距在节点内水平对齐所有子节点。

签名：

alignItemsHorizontally: function(
		self: Node,
		padding?: number --[[10]]
	): Size

参数：

参数名	类型	描述
padding	number	[可选] 子节点之间的间距（默认值为10）。

返回值：

返回类型	描述
Size	对齐后的节点区域大小。

alignItemsHorizontally

类型： 函数。

描述：

  使用给定的范围和间距在节点内水平对齐所有子节点。

签名：

alignItemsHorizontally: function(
		self: Node,
		size: Size,
		padding?: number --[[10]]
	): Size

参数：

参数名	类型	描述
size	Size	用于对齐排布的范围。
padding	number	[可选] 子节点之间的间距（默认值为10）。

返回值：

返回类型	描述
Size	对齐后的节点区域大小。

alignItems

类型： 函数。

描述：

  使用给定间距在节点内对齐所有子节点。

签名：

alignItems: function(
		self: Node,
		padding?: number --[[10]]
	): Size

参数：

参数名	类型	描述
padding	number	[可选] 子节点之间的间距（默认值为10）。

返回值：

返回类型	描述
Size	对齐后的节点区域大小。

alignItems

类型： 函数。

描述：

  使用给定的范围和间距在节点内对齐所有子节点。

签名：

alignItems: function(
		self: Node,
		size: Size,
		padding?: number --[[10]]
	): Size

参数：

参数名	类型	描述
size	Size	用于对齐排布的范围。
padding	number	[可选] 每个子节点之间要使用的填充量（默认值为10）。

返回值：

返回类型	描述
Size	对齐后的节点大小。

moveAndCullItems

类型： 函数。

描述：

  基于子节点在父节点区域中的位置，移动并更改子节点的可见性。

签名：

moveAndCullItems: function(self: Node, delta: Vec2)

参数：

参数名	类型	描述
delta	Vec2	子节点移动的向量。

attachIME

类型： 函数。

描述：

  将操作系统输入法功能 (IME) 开启到节点上。 使节点能接收 "AttachIME"、"DetachIME"、"TextInput"、"TextEditing" 事件。

签名：

attachIME: function(self: Node)

detachIME

类型： 函数。

描述：

  在节点上关闭操作系统输入法 (IME)。

签名：

detachIME: function(self: Node)

gslot

类型： 函数。

描述：

  获取挂在节点上的监听特定全局事件的所有信号槽。

签名：

gslot: function(self: Node, eventName: string): {GSlot}

参数：

参数名	类型	描述
eventName	string	全局事件的名称。

返回值：

返回类型	描述
{GSlot}	节点上监听对应全局事件的所有信号槽。

gslot

类型： 函数。

描述：

  在节点上注册监听全局事件的回调函数。

签名：

gslot: function(self: Node, eventName: string, handler: function()): GSlot

参数：

参数名	类型	描述
eventName	string	全局事件的名称。
handler	function	全局事件的处理函数。

返回值：

返回类型	描述
GSlot	节点上监听该全局事件的监听器对象。

slot

类型： 函数。

描述：

  获取挂在节点上的监听特定节点事件的所有信号槽。

签名：

slot: function(self: Node, eventName: string): Slot

参数：

参数名	类型	描述
eventName	string	节点事件的名称。

返回值：

返回类型	描述
Slot	节点上监听对应节点事件的信号槽。

slot

类型： 函数。

描述：

  在节点上注册监听节点事件的回调函数。

签名：

slot: function(self: Node, eventName: string, handler: function())

参数：

参数名	类型	描述
eventName	string	节点事件的名称。
handler	function	节点事件的处理函数。

emit

类型： 函数。

描述：

  发送一个节点事件。

签名：

emit: function(self: Node, eventName: string, ...: any)

参数：

参数名	类型	描述
eventName	string	节点事件的名称。
...	...any	传递给节点事件处理函数的参数。

grab

类型： 函数。

描述：

  创建或移除节点上的纹理抓取器。

签名：

grab: function(
		self: Node,
		enabled?: boolean --[[true]]
	): Grabber

参数：

参数名	类型	描述
enabled	boolean	[可选] 是否启用或禁用抓取器。默认为 true。

返回值：

返回类型	描述
Grabber	启用时会返回一个抓取器对象（gridX 和 gridY 均为 1）。

grab

类型： 函数。

描述：

  创建一个指定网格大小的纹理抓取器。

签名：

grab: function(self: Node, gridX: number, gridY: number): Grabber

参数：

参数名	类型	描述
gridX	number	将抓取器分成的水平网格单元数。
gridY	number	将抓取器分成的垂直网格单元数。

返回值：

返回类型	描述
Grabber	返回一个抓取器对象。

onUpdate

类型： 函数。

描述：

  调度一个函数，该函数会在每一帧运行。可以反复调用以同时调度多个函数。

签名：

onUpdate: function(self: Node, func: function(number): boolean)

参数：

参数名	类型	描述
func	function	要在每一帧运行的函数，返回true以停止。

onUpdate

类型： 函数。

描述：

  调度一个协程，该协程会在每一帧运行。可以反复调用以同时调度多个协程。

签名：

onUpdate: function(self: Node, job: Routine.Job)

参数：

参数名	类型	描述
job	Routine.Job	要在每一帧运行的协程。

onRender

类型： 函数。

描述：

  注册节点进入渲染阶段时触发的回调函数。该回调在每一帧都会被调用，并且能确保它的调用顺序与场景树的渲染顺序一致，如使子节点在父节点之后渲染。推荐用于调用矢量绘图的接口。

签名：

onRender: function(self: Node, func: function(number): boolean)

参数：

参数名	类型	描述
func	function	渲染时的回调函数。

onActionEnd

类型： 函数。

描述：

  注册节点执行完一个动作时触发的回调函数。

签名：

onActionEnd: function(self: Node, callback: function(action: Action, target: Node))

参数：

参数名	类型	描述
callback	function	动作执行完时的回调函数。

onTapFilter

类型： 函数。

描述：

  注册节点点击事件的过滤器回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onTapFilter: function(self: Node, callback: function(touch: Touch))

参数：

参数名	类型	描述
callback	function	点击事件的过滤器回调函数。

onTapBegan

类型： 函数。

描述：

  注册节点检测到点击开始时触发的回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onTapBegan: function(self: Node, callback: function(touch: Touch))

参数：

参数名	类型	描述
callback	function	点击事件开始的回调函数。

onTapEnded

类型： 函数。

描述：

  注册节点点击结束时触发的回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onTapEnded: function(self: Node, callback: function(touch: Touch))

参数：

参数名	类型	描述
callback	function	点击事件结束的回调函数。

onTapped

类型： 函数。

描述：

  注册节点检测到并结束点击时触发的回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onTapped: function(self: Node, callback: function(touch: Touch))

参数：

参数名	类型	描述
callback	function	点击事件结束的回调函数。

onTapMoved

类型： 函数。

描述：

  注册节点点击移动时触发的回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onTapMoved: function(self: Node, callback: function(touch: Touch))

参数：

参数名	类型	描述
callback	function	点击事件移动的回调函数。

onMouseWheel

类型： 函数。

描述：

  注册节点滚动鼠标滚轮时触发的回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onMouseWheel: function(self: Node, callback: function(delta: Vec2))

参数：

参数名	类型	描述
callback	function	鼠标滚轮滚动的回调函数。

onGesture

类型： 函数。

描述：

  注册节点识别到多点手势时触发的回调函数。 同时会设置节点的touchEnabled属性为 true。

签名：

onGesture: function(self: Node, callback: function(center: Vec2, numFingers: integer, deltaDist: number, deltaAngle: number))

参数：

参数名	类型	描述
callback	function	多点手势的回调函数。

onEnter

类型： 函数。

描述：

  注册节点进入场景树时触发的回调函数。

签名：

onEnter: function(self: Node, callback: function())

参数：

参数名	类型	描述
callback	function	节点进入场景树时的回调函数。

onExit

类型： 函数。

描述：

  注册节点离开场景树时触发的回调函数。

签名：

onExit: function(self: Node, callback: function())

参数：

参数名	类型	描述
callback	function	节点离开场景树时的回调函数。

onCleanup

类型： 函数。

描述：

  注册节点清理时触发的回调函数。

签名：

onCleanup: function(self: Node, callback: function())

参数：

参数名	类型	描述
callback	function	节点清理时的回调函数。

onKeyDown

类型： 函数。

描述：

  注册按下键盘按键时触发的回调函数。 同时会设置节点的keyboardEnabled属性为 true。

签名：

onKeyDown: function(self: Node, callback: function(keyName: Keyboard.KeyName))

参数：

参数名	类型	描述
callback	function	按键按下时的回调函数。

onKeyUp

类型： 函数。

描述：

  注册释放键盘按键时触发的回调函数。 同时会设置节点的keyboardEnabled属性为 true。

签名：

onKeyUp: function(self: Node, callback: function(keyName: Keyboard.KeyName))

参数：

参数名	类型	描述
callback	function	按键释放时的回调函数。

onKeyPressed

类型： 函数。

描述：

  注册按键盘按键时触发的回调函数。 同时会设置节点的keyboardEnabled属性为 true。

签名：

onKeyPressed: function(self: Node, callback: function(keyName: Keyboard.KeyName))

参数：

参数名	类型	描述
callback	function	按键按下时的回调函数。

onAttachIME

类型： 函数。

描述：

  注册打开操作系统输入法 (IME) 时触发的回调函数。

签名：

onAttachIME: function(self: Node, callback: function())

参数：

参数名	类型	描述
callback	function	打开输入法时的回调函数。

onDetachIME

类型： 函数。

描述：

  注册关闭操作系统输入法 (IME) 时触发的回调函数。

签名：

onDetachIME: function(self: Node, callback: function())

参数：

参数名	类型	描述
callback	function	关闭输入法时的回调函数。

onTextInput

类型： 函数。

描述：

  注册输入文本时触发的回调函数。

签名：

onTextInput: function(self: Node, callback: function(text: string))

参数：

参数名	类型	描述
callback	function	输入文本时的回调函数。

onTextEditing

类型： 函数。

描述：

  注册编辑文本时触发的回调函数。

签名：

onTextEditing: function(self: Node, callback: function(text: string, startPos: integer))

参数：

参数名	类型	描述
callback	function	编辑文本时的回调函数。

onButtonDown

类型： 函数。

描述：

  注册按下游戏手柄按键时触发的回调函数。 同时会设置节点的controllerEnabled属性为 true。

签名：

onButtonDown: function(self: Node, callback: function(controllerId: integer, buttonName: Controller.ButtonName))

参数：

参数名	类型	描述
callback	function	按键按下时的回调函数。

onButtonUp

类型： 函数。

描述：

  注册释放游戏手柄按键时触发的回调函数。 同时会设置节点的controllerEnabled属性为 true。

签名：

onButtonUp: function(self: Node, callback: function(controllerId: integer, buttonName: Controller.ButtonName))

参数：

参数名	类型	描述
callback	function	按键释放时的回调函数。

onButtonPressed

类型： 函数。

描述：

  注册按住游戏手柄按键时触发的回调函数。 同时会设置节点的controllerEnabled属性为 true。

签名：

onButtonPressed: function(self: Node, callback: function(controllerId: integer, buttonName: Controller.ButtonName))

参数：

参数名	类型	描述
callback	function	按键按住时的回调函数。

onAxis

类型： 函数。

描述：

  注册游戏控制器轴发生变化时触发的回调函数。 同时会设置节点的controllerEnabled属性为 true。

签名：

onAxis: function(self: Node, callback: function(controllerId: integer, axisName: Controller.AxisName, value: number))

参数：

参数名	类型	描述
callback	function	控制器轴变化时的回调函数。

Node.AppEventType

类型： 枚举。

描述：

  应用程序事件的枚举。

签名：

enum AppEventType

	-- 应用程序即将退出。
	"Quit"

	-- 应用程序收到低内存警告。
	"LowMemory"

	-- 应用程序即将进入后台。
	"WillEnterBackground"

	-- 应用程序已进入后台。
	"DidEnterBackground"

	-- 应用程序即将进入前台。
	"WillEnterForeground"

	-- 应用程序已进入前台。
	"DidEnterForeground"
end

onAppEvent

类型： 函数。

描述：

  注册应用程序事件发生时触发的回调函数。

签名：

onAppEvent: function(self: Node, callback: function(eventType: AppEventType))

参数：

参数名	类型	描述
callback	function	要注册的回调函数。

Node.AppSettingName

类型： 枚举。

描述：

  应用程序设置的枚举。

签名：

enum AppSettingName

	-- 应用程序的区域设置。
	"Locale"

	-- 应用程序的主题颜色。
	"Theme"

	-- 应用程序窗口的全屏状态。
	"FullScreen"

	-- 应用程序窗口的位置。
	"Position"

	-- 应用程序窗口的大小。
	"Size"
end

onAppChange

类型： 函数。

描述：

  注册应用程序设置更改时触发的回调函数。

签名：

onAppChange: function(self: Node, callback: function(settingName: AppSettingName))

参数：

参数名	类型	描述
callback	function	要注册的回调函数。

Node.AppWSEvent

类型： 枚举。

描述：

  应用程序 WebSocket 事件的枚举。

签名：

enum AppWSEvent

	-- WebSocket 连接已打开。
	"Open"

	-- WebSocket 连接已关闭。
	"Close"

	-- WebSocket 接收到消息。
	"Send"

	-- WebSocket 广播消息。
	"Receive"
end

onAppWS

类型： 函数。

描述：

  注册应用程序 WebSocket 事件发生时触发的回调函数。

签名：

onAppWS: function(self: Node, callback: function(event: AppWSEvent, message: string))

参数：

参数名	类型	描述
callback	function	要注册的回调函数。