API
Return to top
BlockingVolume
编辑

玩法 / BlockingVolume

BlockingVolume Class
​

禁行区

用于控制角色是否可以进出此区域。

Precautions

该对象各端生成，通行许可由服务器同步到客户端

使用示例:创建一个名为"BlockingVolExample"的脚本，放置在对象栏中，打开脚本，输入以下代码，替换GUID保存，运行游戏，你将可以通过该GUID对应的禁行区。代码如下：
ts
@Component
export default class BlockingVolExample extends Script {
    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected async onStart(): Promise<void> {
        // 获取当前玩家
        let player = await mw.Player.asyncGetLocalPlayer();
        // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
        let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
        if(SystemUtil.isClient())
        {
            mw.InputUtil.onKeyDown(Keys.F1,()=>{
                // F1键 通知服务器执行事件 参数传入当前玩家
                mw.Event.dispatchToServer(`AddPlayerPassable`,player);
            })
        }
        if(SystemUtil.isServer()){
            // 侦听客户端通知
            mw.Event.addClientListener(`AddPlayerPassable`,(player : Player)=>{
            // 玩家角色添加通行许可
            blockingVolume.addPassableTarget(player.character);
            })
        }
    }
}
@Component
export default class BlockingVolExample extends Script {
    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected async onStart(): Promise<void> {
        // 获取当前玩家
        let player = await mw.Player.asyncGetLocalPlayer();
        // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
        let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
        if(SystemUtil.isClient())
        {
            mw.InputUtil.onKeyDown(Keys.F1,()=>{
                // F1键 通知服务器执行事件 参数传入当前玩家
                mw.Event.dispatchToServer(`AddPlayerPassable`,player);
            })
        }
        if(SystemUtil.isServer()){
            // 侦听客户端通知
            mw.Event.addClientListener(`AddPlayerPassable`,(player : Player)=>{
            // 玩家角色添加通行许可
            blockingVolume.addPassableTarget(player.character);
            })
        }
    }
}

Hierarchy ​

Table of contents ​

Properties
​

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
​

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
​

addPassableTarget(target: GameObject): void other
为目标添加通过该区域的权限
clear(): void other
重置禁行区
getTargetPassable(target: GameObject): boolean
获得目标通过该区域的权限
removePassableTarget(target: GameObject): void other
移除目标通过该区域的权限
unblockAll(): void other
开放禁行区
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 ​

Accessors ​

Methods ​

addPassableTarget
​

• addPassableTarget(target): void other

为目标添加通过该区域的权限

Parameters ​

target GameObjectGameObject
使用示例: 针对此禁行区为其他GameObject添加通行许可
ts
 // 获取当前玩家
 let player =  Player.localPlayer;
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F1,()=>{
         // F1键 通知服务器执行事件 参数传入当前玩家
         mw.Event.dispatchToServer(`AddPlayerPassable`,player);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`AddPlayerPassable`,(player : Player)=>{
     // 玩家角色添加通行许可
     blockingVolume.addPassableTarget(player.character);
     })
 }
 // 获取当前玩家
 let player =  Player.localPlayer;
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F1,()=>{
         // F1键 通知服务器执行事件 参数传入当前玩家
         mw.Event.dispatchToServer(`AddPlayerPassable`,player);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`AddPlayerPassable`,(player : Player)=>{
     // 玩家角色添加通行许可
     blockingVolume.addPassableTarget(player.character);
     })
 }

clear
​

• clear(): void other

重置禁行区

使用示例: 重置该禁行区发布的所有通行许可
ts
  // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F4,()=>{
         // F4键 通知服务器执行事件
         mw.Event.dispatchToServer(`Clear`);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`Clear`,()=>{
     // 重置该禁行区通行许可
     blockingVolume.clear();
     })
 }
  // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F4,()=>{
         // F4键 通知服务器执行事件
         mw.Event.dispatchToServer(`Clear`);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`Clear`,()=>{
     // 重置该禁行区通行许可
     blockingVolume.clear();
     })
 }

getTargetPassable
​

• getTargetPassable(target): boolean

获得目标通过该区域的权限

Parameters ​

target GameObjectGameObject

Returns ​

booleanbool
使用示例: 获取此禁行区对某GameObject的通行许可
ts
 // 获取当前玩家
 let player = Player.localPlayer;
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 InputUtil.onKeyDown(Keys.F3,()=>{
     // F3键 获取玩家角色的通行权限
     blockingVolume.getTargetPassable(player.character);
 })
 // 获取当前玩家
 let player = Player.localPlayer;
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 InputUtil.onKeyDown(Keys.F3,()=>{
     // F3键 获取玩家角色的通行权限
     blockingVolume.getTargetPassable(player.character);
 })

removePassableTarget
​

• removePassableTarget(target): void other

移除目标通过该区域的权限

Parameters ​

target GameObjectGameObject
使用示例: 针对此禁行区为其他GameObject移除通行许可
ts
 // 获取当前玩家
 let player =  Player.localPlayer;
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F2,()=>{
         // F2键 通知服务器执行事件 参数传入当前玩家
         mw.Event.dispatchToServer(`RemovePlayerPassable`,player);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`RemovePlayerPassable`,(player : Player)=>{
     // 玩家角色移除通行许可
     blockingVolume.removePassableTarget(player.character);
     })
 }
 // 获取当前玩家
 let player =  Player.localPlayer;
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncFindGameObjectById(`GUID`) as BlockingVolume;
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F2,()=>{
         // F2键 通知服务器执行事件 参数传入当前玩家
         mw.Event.dispatchToServer(`RemovePlayerPassable`,player);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`RemovePlayerPassable`,(player : Player)=>{
     // 玩家角色移除通行许可
     blockingVolume.removePassableTarget(player.character);
     })
 }

unblockAll
​

• unblockAll(): void other

开放禁行区

使用示例: 开放该禁行区
ts
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncSpawn<BlockingVolume>(`BlockingVolume`);
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F5,()=>{
         // F5键 通知服务器执行事件
         mw.Event.dispatchToServer(`UnblockAll`);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`UnblockAll`,()=>{
     // 该禁行区开放通行
     blockingVolume.unblockAll();
     })
 }
 // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
 let blockingVolume = await GameObject.asyncSpawn<BlockingVolume>(`BlockingVolume`);
 if(SystemUtil.isClient())
 {
     InputUtil.onKeyDown(Keys.F5,()=>{
         // F5键 通知服务器执行事件
         mw.Event.dispatchToServer(`UnblockAll`);
     })
 }
 if(SystemUtil.isServer()){
     // 侦听客户端通知
     mw.Event.addClientListener(`UnblockAll`,()=>{
     // 该禁行区开放通行
     blockingVolume.unblockAll();
     })
 }