玩法 / Interactor
Interactor Class
交互物,请保证交互前动画资源已加载,否则可能导致位置错误或者其他不可预料的表现
使用示例:创建一个名为"InteractorSample"的脚本,放置在对象管理器某一交互物的子级中,打开脚本,输入以下代码保存,在本地资源库中搜索4175动画资源,拖入对象管理器中的优先加载目录。运行游戏,你将在场景中看到一个交互物的效果,玩家可以和此交互物进行交互,代码如下:ts
@Component
export default class InteractorSample extends Script {
protected async onStart(): Promise<void> {
const interObj = this.gameObject as Interactor;
// 开始交互回调
interObj.onEnter.add(() => {
console.log("onEnter")
console.log("onEnter ", interObj.getCurrentCharacter())
console.log("onEnter ", interObj.occupied)
})
interObj.slot = HumanoidSlotType.Buttocks;
interObj.animationId = "4175";
// 结束交互回调
interObj.onLeave.add(() => {
console.log("onLeave")
})
if (SystemUtil.isClient()) {
InputUtil.onKeyDown(Keys.One, () => {
interObj.enter(Player.localPlayer.character, HumanoidSlotType.Buttocks, "4175");
})
InputUtil.onKeyDown(Keys.Two, () => {
// 不传退出交互时会自动回到交互前的坐标和旋转
interObj.leave();
})
}
}
}
@Component
export default class InteractorSample extends Script {
protected async onStart(): Promise<void> {
const interObj = this.gameObject as Interactor;
// 开始交互回调
interObj.onEnter.add(() => {
console.log("onEnter")
console.log("onEnter ", interObj.getCurrentCharacter())
console.log("onEnter ", interObj.occupied)
})
interObj.slot = HumanoidSlotType.Buttocks;
interObj.animationId = "4175";
// 结束交互回调
interObj.onLeave.add(() => {
console.log("onLeave")
})
if (SystemUtil.isClient()) {
InputUtil.onKeyDown(Keys.One, () => {
interObj.enter(Player.localPlayer.character, HumanoidSlotType.Buttocks, "4175");
})
InputUtil.onKeyDown(Keys.Two, () => {
// 不传退出交互时会自动回到交互前的坐标和旋转
interObj.leave();
})
}
}
}
Hierarchy
↳
Interactor
Table of contents
Properties
onEnter: MulticastDelegate <() => void > |
---|
交互开始时执行绑定函数。通常与 enter 成对使用,使用示例详见方法 enter 中示例代码。 |
onLeave: MulticastDelegate <() => void > |
交互结束时执行绑定函数。通常与 leave 成对使用,使用示例详见方法 leave 中示例代码。 |
click
Properties
onBeforeDestroyDelegate: MulticastDelegate <() => void > |
---|
物体销毁前事件回调 |
onCustomPropertyChange: Readonly <MulticastDelegate <(path : string , value : unknown , oldValue : unknown ) => void >> other |
监听自定义属性同步事件 |
onDestroyDelegate: MulticastDelegate <() => void > |
物体销毁后事件回调 |
onPropertyChange: Readonly <MulticastDelegate <(path : string , value : unknown , oldValue : unknown ) => void >> |
监听系统属性同步事件 |
Accessors
animationId(): string |
---|
交互动画资源 id |
nonHumanoidAnimationId(): string |
交互非人形动画资源 id |
nonHumanoidSlot(): NonHumanoidSlotType |
交互物非人形插槽 |
occupied(): boolean |
该交互物的交互状态 |
slot(): HumanoidSlotType |
交互物插槽 |
click
Accessors
actorFlagValue(): number other |
---|
获取对象标记 |
actorLevel(): number other |
获取Actor等级 |
assetId(): string |
获取当前物体使用资源的GUID |
gameObjectId(): string |
获取物体的唯一标识(唯一标识一个对象的字符串)。 |
isDestroyed(): boolean |
当前物体是否被销毁 |
isReady(): boolean |
当前物体状态 |
localTransform(): Transform |
当前物体本地变换 |
name(): string |
返回当前物体名称 |
netStatus(): NetStatus |
获取当前物体同步状态 |
parent(): GameObject |
获取当前父物体 |
tag(): string |
获取当前物体的标签 |
worldTransform(): Transform |
当前物体世界变换 |
Methods
enter(character : Character , slot? : HumanoidSlotType NonHumanoidSlotType , animationId? : string ): boolean other |
---|
开始交互,请保证交互前动画资源已加载,否则可能导致位置错误或者其他不可预料的表现 |
getCurrentCharacter(): Character |
获取正在交互的角色 |
leave(position? : Vector , rotation? : Rotation , animationId? : string ): boolean other |
结束交互。通常与 enter 成对使用,使用示例详见方法 enter 中示例代码。 |
click
Methods
addComponent<T : extends Script <T >>(constructor : (...args : unknown []) => T : extends Script <T >, bInReplicates? : boolean ): T : extends Script <T > |
---|
添加一个脚本组件 |
asyncGetChildByName(name : string ): Promise <GameObject > |
异步根据名称查找子物体 |
asyncReady(): Promise <GameObject > |
物体准备好后返回 |
clone(gameObjectInfo? : GameObjectInfo ): GameObject |
复制对象 |
destroy(): void |
删除对象 |
getBoundingBox(nonColliding? : boolean , includeFromChild? : boolean , outer? : Vector ): Vector |
获取物体包围盒大小 |
getBounds(onlyCollidingComponents : boolean , originOuter : Vector , boxExtentOuter : Vector , includeFromChild? : boolean ): void |
获取物体边界 |
getChildByGameObjectId(gameObjectId : string ): GameObject |
根据 gameObjectId 查找子物体 |
getChildByName(name : string ): GameObject |
根据名称查找子物体 |
getChildByPath(path : string ): GameObject |
根据路径查找子物体 |
getChildren(): GameObject [] |
获取子物体 |
getChildrenBoundingBoxCenter(outer? : Vector ): Vector |
获取所有子对象包围盒中心点(不包含父对象,父对象不可用返回[0,0,0]) |
getChildrenByName(name : string ): GameObject [] |
通过名字查找所有的子物体 |
getComponent<T : extends Script <T >>(constructor? : (...args : unknown []) => T : extends Script <T >): T : extends Script <T > |
获取指定类型的组件 |
getComponentPropertys<T : extends Script <T >>(constructor : (...args : unknown []) => T : extends Script <T >): Map <string , IPropertyOptions > |
获取脚本组件属性 |
getComponents<T : extends Script <T >>(constructor? : (...args : unknown []) => T : extends Script <T >): T : extends Script <T >[] |
获取指定类型的所有组件 |
getCustomProperties(): string [] |
获取所有自定义属性 |
getCustomProperty<T : extends CustomPropertyType >(propertyName : string ): T : extends CustomPropertyType |
获取自定义属性 |
getCustomPropertyChangeDelegate(property ): Readonly <MulticastDelegate <(path : string , value : unknown , oldValue : unknown ) => void >> other |
给定对象属性修改时触发的事件代理 |
getPropertyChangeDelegate(property ): Readonly <MulticastDelegate <(path : string , value : unknown , oldValue : unknown ) => void >> other |
给定对象属性修改时触发的事件代理 |
getVisibility(): boolean |
获取物体是否被显示 |
isPrefabActor(): boolean |
返回当前物体是否为预制体 |
moveBy(velocity : Vector , isLocal? : boolean ): void other |
按给定的速度矢量随时间平滑地移动对象 |
moveTo(targetPosition : Vector , time : number , isLocal? : boolean , onComplete? : () => void ): void other |
在指定时间内从当前位置平滑移动至目标位置 |
rotateBy(rotation : Quaternion Rotation , multiplier : number , isLocal? : boolean ): void other |
按给定的旋转量随时间平滑地旋转对象 |
rotateTo(targetRotation : Quaternion Rotation , time : number , isLocal? : boolean , onComplete? : () => void ): void other |
在指定时间内从当前旋转平滑变化至目标旋转 |
scaleBy(scale : Vector , isLocal? : boolean ): void other |
按每秒给定的缩放矢量随时间平滑缩放对象 |
scaleTo(targetScale : Vector , time : number , isLocal? : boolean , onComplete? : () => void ): void other |
在指定时间内从当前缩放平滑变化至目标缩放 |
setAbsolute(absolutePosition? : boolean , absoluteRotation? : boolean , absoluteScale? : boolean ): void |
设置物体localTransform是相对于父物体或者世界 |
setCustomProperty(propertyName : string , value : undefined CustomPropertyType ): void |
设置自定义属性 |
setVisibility(status : boolean PropertyStatus , propagateToChildren? : boolean ): void |
设置物体是否被显示 |
stopMove(): void other |
中断moveTo()、moveBy()的进一步移动 |
stopRotate(): void other |
中断从rotateTo()或rotateBy()的进一步旋转 |
stopScale(): void other |
中断从ScaleTo()或ScaleBy()的进一步缩放 |
asyncFindGameObjectById(gameObjectId : string ): Promise <GameObject > |
通过 gameObjectId 异步查找 GameObject |
asyncGetGameObjectByPath(path : string ): Promise <GameObject > |
通过路径异步查找物体 |
asyncSpawn<T : extends GameObject <T >>(assetId : string , gameObjectInfo? : GameObjectInfo ): Promise <T : extends GameObject <T >> |
异步构造一个物体 |
bulkPivotTo(gameObjects : GameObject [], transforms : Transform []): void |
批量设置位置 |
findGameObjectById(gameObjectId : string ): GameObject |
通过 gameObjectId 查找物体 |
findGameObjectByName(name : string ): GameObject |
通过名字查找物体 |
findGameObjectsByName(name : string ): GameObject [] |
通过名字查找物体 |
findGameObjectsByTag(tag : string ): GameObject [] |
通过自定义标签获取物体 |
getGameObjectByPath(path : string ): GameObject |
通过路径查找物体 |
spawn<T : extends GameObject <T >>(assetId : string , gameObjectInfo? : GameObjectInfo ): T : extends GameObject <T > |
构造一个物体 |
Properties
onEnter
• onEnter: MulticastDelegate
<() => void
>
交互开始时执行绑定函数。通常与 enter 成对使用,使用示例详见方法 enter 中示例代码。
Precautions
会自动广播,若是双端对象,则可以在任意客户端调用
onLeave
• onLeave: MulticastDelegate
<() => void
>
交互结束时执行绑定函数。通常与 leave 成对使用,使用示例详见方法 leave 中示例代码。
Precautions
会自动广播,若是双端对象,则可以在任意客户端调用
Accessors
animationId
• | • | ||||
---|---|---|---|---|---|
交互动画资源 id Returns
| 交互动画资源 id Parameters
|
nonHumanoidAnimationId
• | • | ||||
---|---|---|---|---|---|
交互非人形动画资源 id Returns
| 交互非人形动画资源 id Parameters
|
nonHumanoidSlot
• | • | ||||
---|---|---|---|---|---|
交互物非人形插槽 Returns
| 交互物非人形插槽 Parameters
|
occupied
• | ||
---|---|---|
该交互物的交互状态 Returns
|
slot
• | • | ||||
---|---|---|---|---|---|
交互物插槽 Returns
| 交互物插槽 Parameters
|
Methods
enter
• enter(character
, slot?
, animationId?
): boolean
other
开始交互,请保证交互前动画资源已加载,否则可能导致位置错误或者其他不可预料的表现
Parameters
character Character | 要交互的角色(可以是玩家,也可以是AI) |
---|---|
slot? HumanoidSlotType NonHumanoidSlotType | 交互插槽,不传默认以属性 slot 为准 default: 属性 slot |
animationId? string | 交互姿态,不传默认以属性 animationId 为准 default: 属性 animationId range: 依据动画资源 ID 决定字符串长度 |
Returns
boolean | 是否成功交互,异步逻辑,返回值不代表已经完成交互,如需确保已经完成交互,请使用 onEnter 委托 |
---|
ts
@Component
export default class InteractorStartEndSample extends Script {
protected async onStart(): Promise<void> {
const interObj = this.gameObject as Interactor;
// 开始交互回调
interObj.onEnter.add(() => {
console.log("onEnter")
})
// 结束交互回调
interObj.onLeave.add(() => {
console.log("onLeave")
})
if (SystemUtil.isClient()) {
InputUtil.onKeyDown(Keys.One, () => {
interObj.enter(Player.localPlayer.character, HumanoidSlotType.Buttocks, "4175");
})
InputUtil.onKeyDown(Keys.Two, () => {
// 不传退出交互时会自动回到交互前的坐标和旋转
interObj.leave();
})
}
}
}
@Component
export default class InteractorStartEndSample extends Script {
protected async onStart(): Promise<void> {
const interObj = this.gameObject as Interactor;
// 开始交互回调
interObj.onEnter.add(() => {
console.log("onEnter")
})
// 结束交互回调
interObj.onLeave.add(() => {
console.log("onLeave")
})
if (SystemUtil.isClient()) {
InputUtil.onKeyDown(Keys.One, () => {
interObj.enter(Player.localPlayer.character, HumanoidSlotType.Buttocks, "4175");
})
InputUtil.onKeyDown(Keys.Two, () => {
// 不传退出交互时会自动回到交互前的坐标和旋转
interObj.leave();
})
}
}
}
getCurrentCharacter
• getCurrentCharacter(): Character
获取正在交互的角色
Returns
Character | true:为交互中 |
---|
ts
@Component
export default class InteractorGetInteractCharacterSample extends Script {
protected async onStart(): Promise<void> {
const interObj = this.gameObject as Interactor;
// 开始交互回调
interObj.onEnter.add(() => {
console.log(`onEnter status: ${interObj.getCurrentCharacter()}`)
})
// 省略开始交互代码
}
}
@Component
export default class InteractorGetInteractCharacterSample extends Script {
protected async onStart(): Promise<void> {
const interObj = this.gameObject as Interactor;
// 开始交互回调
interObj.onEnter.add(() => {
console.log(`onEnter status: ${interObj.getCurrentCharacter()}`)
})
// 省略开始交互代码
}
}
leave
• leave(position?
, rotation?
, animationId?
): boolean
other
结束交互。通常与 enter 成对使用,使用示例详见方法 enter 中示例代码。
Parameters
position? Vector | 结束位置 default: 玩家开始交互前的坐标为准 |
---|---|
rotation? Rotation | 结束旋转量 default: 玩家开始交互前的旋转为准,如果玩家开始前的姿态是倾斜的,内部不会纠正 |
animationId? string | 新姿态,default: 玩家开始交互前的姿态(动画会转姿态) range: 依据动画资源 ID 决定字符串长度 |
Returns
boolean | true 代表触发了结束交互逻辑,异步操作,返回值不能代表结束交互逻辑已经成功,如需保证结束交互逻辑完成才执行时,请使用 onLeave 委托 |
---|