API
Return to top
WaterVolume
编辑

玩法 / WaterVolume

WaterVolume Class
​

水体区域

拖入 WaterVolume 调整水体区域的大小，角色进入水体区域会切换成游泳状态。

使用示例:创建一个名为"WaterVolumeExample"的脚本，放置在对象栏中，打开脚本，输入以下代码，替换GUID保存，运行游戏，你将可以通过F1键获取角色是否处于该GUID对应的游泳区。
ts
@Component
export default class WaterVolumeExample extends Script {
    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected async onStart(): Promise<void> {
        // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
        let WaterVolume = await GameObject.asyncFindGameObjectById(`GUID`) as WaterVolume;
        if(SystemUtil.isClient())
        {
            InputUtil.onKeyDown(Keys.F1,()=>{
                // F1键 通知获取流体摩擦力
                console.log("当前游泳区流体摩擦力为：" + WaterVolume.fluidFriction);
            });
            InputUtil.onKeyDown(Keys.F2,()=>{
                // F2键 通知获取当前是否开启浮力
                if (WaterVolume.buoyancyEnabled) {
                    console.log("当前游泳区已开启浮力");
                } else {
                    console.log("当前游泳区未开启浮力");
                }
            });
            InputUtil.onKeyDown(Keys.F3,()=>{
                // F3键 通知获取液体密度（用于计算浮力）
                console.log("当前游泳区密度为：" + WaterVolume.density);
            });
        }
    }
}
@Component
export default class WaterVolumeExample extends Script {
    // 当脚本被实例后，会在第一帧更新前调用此函数
    protected async onStart(): Promise<void> {
        // GUID根据实际情况填写，可在编辑器对象管理器内右键复制对象ID
        let WaterVolume = await GameObject.asyncFindGameObjectById(`GUID`) as WaterVolume;
        if(SystemUtil.isClient())
        {
            InputUtil.onKeyDown(Keys.F1,()=>{
                // F1键 通知获取流体摩擦力
                console.log("当前游泳区流体摩擦力为：" + WaterVolume.fluidFriction);
            });
            InputUtil.onKeyDown(Keys.F2,()=>{
                // F2键 通知获取当前是否开启浮力
                if (WaterVolume.buoyancyEnabled) {
                    console.log("当前游泳区已开启浮力");
                } else {
                    console.log("当前游泳区未开启浮力");
                }
            });
            InputUtil.onKeyDown(Keys.F3,()=>{
                // F3键 通知获取液体密度（用于计算浮力）
                console.log("当前游泳区密度为：" + WaterVolume.density);
            });
        }
    }
}

Hierarchy ​

Table of contents ​

Properties
​

onEnter: MulticastGameObjectDelegate
进入水体区域事件
onLeave: MulticastGameObjectDelegate
离开水体区域事件
click

Properties
​

onBeforeDestroyDelegate: MulticastDelegate<() => void>
物体销毁前事件回调
onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
监听自定义属性同步事件
onDestroyDelegate: MulticastDelegate<() => void>
物体销毁后事件回调

Accessors
​

buoyancyEnabled(): boolean
获取是否启用水体浮力
deepColor(): LinearColor other
获取水体深层颜色
density(): number
获取水体密度（用于计算浮力大小）
divingEnabled(): boolean
获取潜水
flowAngle(): number client
获取水波角度
flowSpeed(): number client
获取水波速度
flowTile(): number client
获取水波密度
fluidFriction(): number
获取流体摩擦力
normalFlat(): number client
获取水波强度
preset(): WaterPreset client
获取预设,仅对面板值生效
surfaceColor(): LinearColor
获取水体浅层颜色
transmittance(): number client
获取水体透明度
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
​

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
给定对象属性修改时触发的事件代理
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: MulticastGameObjectDelegate

进入水体区域事件

onLeave
​

• onLeave: MulticastGameObjectDelegate

离开水体区域事件

Accessors ​

buoyancyEnabled
​

• get buoyancyEnabled(): boolean

• set buoyancyEnabled(newStatus): void

获取是否启用水体浮力

Default

false

Returns ​

boolean当前游泳区是否启用水体浮力

开启/关闭区域的浮力效果，在关闭时区域将不再提供"浮力"的物理模拟计算，以节省性能。

Parameters ​

newStatus boolean设置游泳区是否启用水体浮力

deepColor
​

• get deepColor(): LinearColor other

• set deepColor(value): void client

获取水体深层颜色

Returns ​

LinearColor当前游泳区深层颜色

设置水体深层颜色

Parameters ​

value LinearColor设置游泳区深层颜色

density
​

• get density(): number

• set density(newDensity): void

获取水体密度（用于计算浮力大小）

Default

10

Returns ​

number当前水体密度

设置水体密度（用于计算浮力大小），密度越大，浮力越大。

取值范围 [0 - 10000]

Parameters ​

newDensity number新的水体密度

divingEnabled
​

• get divingEnabled(): boolean

• set divingEnabled(value): void

获取潜水

Returns ​

boolean当前游泳区是否启用潜水

设置潜水

Parameters ​

value boolean设置游泳区是否启用潜水

flowAngle
​

• get flowAngle(): number client

• set flowAngle(value): void client

获取水波角度

Returns ​

number当前游泳区水波角度

设置水波角度

Parameters ​

value number设置游泳区水波角度

flowSpeed
​

• get flowSpeed(): number client

• set flowSpeed(value): void client

获取水波速度

Returns ​

number当前游泳区水波速度

设置水波速度

Parameters ​

value number设置游泳区水波速度

flowTile
​

• get flowTile(): number client

• set flowTile(value): void client

获取水波密度

Returns ​

number当前游泳区水波密度

设置水波密度

Parameters ​

value number设置游泳区水波密度

fluidFriction
​

• get fluidFriction(): number

获取流体摩擦力

Returns ​

number当前游泳区流体摩擦力

normalFlat
​

• get normalFlat(): number client

• set normalFlat(value): void client

获取水波强度

Returns ​

number当前游泳区水波强度

设置水波强度

Parameters ​

value number设置游泳区水波强度

preset
​

• get preset(): WaterPreset client

• set preset(NewPreset): void client

获取预设,仅对面板值生效

Returns ​

WaterPreset返回预设

设置预设

Parameters ​

NewPreset WaterPreset预设枚举

surfaceColor
​

• get surfaceColor(): LinearColor

• set surfaceColor(value): void

获取水体浅层颜色

Returns ​

LinearColor当前游泳区浅层颜色

设置水体浅层颜色

Parameters ​

value LinearColor设置游泳区浅层颜色

transmittance
​

• get transmittance(): number client

• set transmittance(value): void client

获取水体透明度

Returns ​

number当前游泳区水体透明度

设置水体透明度

Parameters ​

value number设置游泳区水体透明度

Methods ​