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