Skip to content
RigidConstraint

玩法 / RigidConstraint

RigidConstraint Class

物理链接组件

Precautions

服务器设置,双端自动同步

使用示例: 创建一个名为"RigidTest"的脚本,放置在对象栏中,打开脚本,输入以下代码保存,运行游戏,你将在场景中看到一个正方体和一个球体,将设置绳子约束启用,进行绞盘效果。代码如下:
ts
@Component
export default class RigidTest extends Script {
    box:mw.Model;
    ball:mw.Model;
    rigid:mw.RigidConstraint;
    // 当脚本被实例后,会在第一帧更新前调用此函数
    protected onStart(): void {
        if(SystemUtil.isServer()) {

            GameObject.asyncSpawn("197386",{replicates:true}).then((obj)=>{
                this.box = obj as mw.Model;
                this.box.worldTransform.position = new Vector(200,0,1200);
            });
            GameObject.asyncSpawn("197388",{replicates:true}).then((obj)=>{
                this.ball = obj as mw.Model;
                this.ball.worldTransform.position = new Vector(100,0,100);
                // 使用链接组件的一方必须开启物理模拟
                this.ball.physicsEnabled = true;
            })
            // 创建链接组件链接Box与ball
            setTimeout(()=>{
                GameObject.asyncSpawn("RigidConstraint",{replicates:true}).then((obj)=>{
                    this.rigid = obj as mw.RigidConstraint;
                    this.rigid.constraint1 = this.box;
                    this.rigid.constraint2 = this.ball;
                    this.rigid.softConstraintEnabled = true;
                    this.rigid.length = 800;
                    this.rigid.autoEnable = true;
                    // 开启铰链拉到ball到target位置
                    setTimeout(() => {
                        this.rigid.winchEnabled = true;
                        this.rigid.winchForce = 10000;
                        this.rigid.winchSpeed = 150;
                        this.rigid.winchTarget = 200;
                    }, 5000);
                })
            }, 10000);
        }
    }
}
@Component
export default class RigidTest extends Script {
    box:mw.Model;
    ball:mw.Model;
    rigid:mw.RigidConstraint;
    // 当脚本被实例后,会在第一帧更新前调用此函数
    protected onStart(): void {
        if(SystemUtil.isServer()) {

            GameObject.asyncSpawn("197386",{replicates:true}).then((obj)=>{
                this.box = obj as mw.Model;
                this.box.worldTransform.position = new Vector(200,0,1200);
            });
            GameObject.asyncSpawn("197388",{replicates:true}).then((obj)=>{
                this.ball = obj as mw.Model;
                this.ball.worldTransform.position = new Vector(100,0,100);
                // 使用链接组件的一方必须开启物理模拟
                this.ball.physicsEnabled = true;
            })
            // 创建链接组件链接Box与ball
            setTimeout(()=>{
                GameObject.asyncSpawn("RigidConstraint",{replicates:true}).then((obj)=>{
                    this.rigid = obj as mw.RigidConstraint;
                    this.rigid.constraint1 = this.box;
                    this.rigid.constraint2 = this.ball;
                    this.rigid.softConstraintEnabled = true;
                    this.rigid.length = 800;
                    this.rigid.autoEnable = true;
                    // 开启铰链拉到ball到target位置
                    setTimeout(() => {
                        this.rigid.winchEnabled = true;
                        this.rigid.winchForce = 10000;
                        this.rigid.winchSpeed = 150;
                        this.rigid.winchTarget = 200;
                    }, 5000);
                })
            }, 10000);
        }
    }
}

Hierarchy

Table of contents

Properties

onWinchComplete: MulticastDelegate<() => void>
绞盘达到目标时触发回调函数
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

autoEnable(): boolean
在运行时自动启用约束效果
constraint1(): GameObject
被约束对象1,当前可约束类型为模型、角色、NPC、载具,其他对象约束无效
constraint2(): GameObject
被约束对象2,当前可约束类型为模型、角色、NPC、载具,其他对象约束无效
currentDistance(): number
两个被约束对象的间隔距离
isVisible(): boolean
显示连接线
length(): number
设置两个被约束对象的最大连接距离,当两个被约束对象的当前距离大于连接长度时,会自动收缩物理连接,接两个被约束对象拉进到设定距离
softConstraintEnabled(): boolean
开启软连接后,两个被约束的对象间隔距离不可超过连接长度的限制,可以短于连接长度并自由旋转。开启软连接后可以使用铰盘功能
winchEnabled(): boolean
开启后,软连接自动执行铰盘效果
winchForce(): number
设置绞盘的拉力,拉动的目标质量越大,所需要的拉力越大
winchSpeed(): number
设置绞盘运动速度(cm/s)
winchTarget(): number
设置绞盘运动的目标距离,当被约束的两个对象间隔距离达到绞盘目标时,停止运动
click

Accessors

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
给定对象属性修改时触发的事件代理
getPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> other
给定对象属性修改时触发的事件代理
getVisibility(): 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


onWinchComplete

onWinchComplete: MulticastDelegate<() => void>

绞盘达到目标时触发回调函数

Accessors


autoEnable

get autoEnable(): boolean

set autoEnable(newEnable): void

在运行时自动启用约束效果

Returns

boolean启用状态

在运行时自动启用约束效果

Parameters

newEnable boolean启用状态

constraint1

get constraint1(): GameObject

set constraint1(constraintObject): void

被约束对象1,当前可约束类型为模型、角色、NPC、载具,其他对象约束无效

Returns

GameObject约束对象1

被约束对象1,当前可约束类型为模型、角色、NPC、载具,其他对象约束无效

Parameters

constraintObject GameObject约束对象1

constraint2

get constraint2(): GameObject

set constraint2(constraintObject): void

被约束对象2,当前可约束类型为模型、角色、NPC、载具,其他对象约束无效

Returns

GameObject约束对象2

被约束对象2,当前可约束类型为模型、角色、NPC、载具,其他对象约束无效

Parameters

constraintObject GameObject约束对象2

currentDistance

get currentDistance(): number

两个被约束对象的间隔距离

Returns

number两约束对象的间隔距离

isVisible

get isVisible(): boolean

set isVisible(visible): void

显示连接线

Returns

boolean显示状态

显示连接线

Parameters

visibleboolean

length

get length(): number

set length(maxLength): void

设置两个被约束对象的最大连接距离,当两个被约束对象的当前距离大于连接长度时,会自动收缩物理连接,接两个被约束对象拉进到设定距离

Returns

number最大连接距离

设置两个被约束对象的最大连接距离,当两个被约束对象的当前距离大于连接长度时,会自动收缩物理连接,接两个被约束对象拉进到设定距离

Parameters

maxLength number最大连接距离

softConstraintEnabled

get softConstraintEnabled(): boolean

set softConstraintEnabled(newEnable): void

开启软连接后,两个被约束的对象间隔距离不可超过连接长度的限制,可以短于连接长度并自由旋转。开启软连接后可以使用铰盘功能

Returns

boolean软链接启用状态

开启软连接后,两个被约束的对象间隔距离不可超过连接长度的限制,可以短于连接长度并自由旋转。开启软连接后可以使用铰盘功能

Parameters

newEnable boolean软链接启用状态

winchEnabled

get winchEnabled(): boolean

set winchEnabled(newEnable): void

开启后,软连接自动执行铰盘效果

Returns

boolean绞盘启用状态

开启后,软连接自动执行铰盘效果

Parameters

newEnable boolean绞盘启用状态

winchForce

get winchForce(): number

set winchForce(force): void

设置绞盘的拉力,拉动的目标质量越大,所需要的拉力越大

Returns

number绞盘力大小

设置绞盘的拉力,拉动的目标质量越大,所需要的拉力越大

Parameters

force number绞盘力大小

winchSpeed

get winchSpeed(): number

set winchSpeed(speed): void

设置绞盘运动速度(cm/s)

Returns

number绞盘运动速度

设置绞盘运动速度(cm/s)

Parameters

speed number绞盘运动速度

winchTarget

get winchTarget(): number

set winchTarget(targetLength): void

设置绞盘运动的目标距离,当被约束的两个对象间隔距离达到绞盘目标时,停止运动

Returns

number绞盘目标距离

设置绞盘运动的目标距离,当被约束的两个对象间隔距离达到绞盘目标时,停止运动

Parameters

targetLength number绞盘目标距离

Methods