玩法 / AdvancedVehicle
AdvancedVehicle Class
四轮载具
四轮载具是指模拟四个车轮的交通工具,例如汽车、卡车等。它们被设计成能够在游戏中自由移动、加速和转向,给玩家带来真实的驾驶体验。
Precautions
注意事项
- 在未设置有效的owner之前,载具不会进行物理模拟,可能会遇到悬空等现象。
- 载具由set owner时指定的玩家客户端控制。如果想设置载具位置,仅在服务器端设置位置是无效的,需要主控端一起修改。
- 应注意同一客户端同时控制的载具数量,数量过大会影响载具的同步。建议在5个以内。
ts
enum VehicleEvents {
createVehicle_C2S = "createVehicle_C2S",
createVehicle_S2C = "createVehicle_S2C",
outOfVehicle_local = "outOfVehicle_local",
}
@Component
export default class VehicleSample extends Script {
// 该属性暴露在属性面板中,可以方便的进行调整。
@Property({ displayName: "载具生成位置", hideInEditor: false })
private vehicleSpawnLoc: Vector = new Vector(100, 100, 200);
// 当前控制的载具。
private vehicle: AdvancedVehicle = null;
// 当前载具下面的交互物。
private interactor: Interactor = null;
// 当前载具下面的触发器,用于上下车。
private trigger: Trigger = null;
// 当前绑定的按钮事件handle,用于下车时解除绑定。
private controlEventsHandle: mw.EventListener[] = [];
// 当脚本被实例后,会在第一帧更新前调用此函数。
protected onStart(): void {
AssetUtil.asyncDownloadAsset("14015");
this.bindCreationEvents();
}
// 绑定载具创建的事件
private bindCreationEvents(): void {
if (SystemUtil.isServer()) {
mw.Event.addClientListener(VehicleEvents.createVehicle_C2S, async (player: Player) => {
// 创建载具。
this.vehicle = await mw.GameObject.asyncSpawn<mw.AdvancedVehicle> ("Vehicle4W", {
replicates: true,
transform: new Transform(this.vehicleSpawnLoc, new Rotation(0, 0, 0), new Vector(1)),
})
// 创建触发器。
this.trigger = await mw.GameObject.asyncSpawn<mw.Trigger> ("Trigger", {
replicates: true,
})
// 创建交互物。
this.interactor = await mw.GameObject.asyncSpawn<mw.Interactor>("Interactor", {
replicates: true,
})
// 创建一个Box,作为车身。
const vehicleMesh = await mw.GameObject.asyncSpawn<mw.Model>("197386", {
replicates: true,
})
// 设置父子级关系。
this.interactor.parent = this.vehicle;
this.trigger.parent = this.vehicle;
vehicleMesh.parent = this.vehicle;
// 调整相对位置,使得玩家上车时刚好坐在Box上,下车时在触发器旁边。
this.interactor.localTransform.position = new mw.Vector(0, 0, 150);
this.trigger.localTransform.position = new mw.Vector(0, -100, 0);
vehicleMesh.localTransform.position= new mw.Vector(0, 0, 50);
// 通知发起请求的客户端,载具已经创建完成。因为我们只通知了发起请求的客户端,所以每个客户端只能驾驶自己请求创建的载具。
mw.Event.dispatchToClient(player, VehicleEvents.createVehicle_S2C, [
this.vehicle.gameObjectId,
this.trigger.gameObjectId,
this.interactor.gameObjectId,
])
})
} else {
InputUtil.onKeyDown(Keys.Q, () => {
// 通过RPC调用,在服务器上动态生成载具以及触发器,交互物。
mw.Event.dispatchToServer(VehicleEvents.createVehicle_C2S);
})
// 客户端监听服务器生成完毕的消息,绑定触发器的事件,实现上下车功能。
mw.Event.addServerListener(VehicleEvents.createVehicle_S2C, async (info: string[]) => {
const [vehicleGUID, triggerGUID, interactorGUID] = info;
console.log(`vehicleGUID = [${vehicleGUID}], triggerGUID = [${triggerGUID}], interactorGUID = [${interactorGUID}]`);
this.vehicle = await GameObject.asyncFindGameObjectById(vehicleGUID) as AdvancedVehicle;
this.trigger = await GameObject.asyncFindGameObjectById(triggerGUID) as Trigger;
this.interactor = await GameObject.asyncFindGameObjectById(interactorGUID) as Interactor;
this.bindInOutVehicleEvents();
})
}
}
// 绑定触发器的事件,实现上下车功能。
private bindInOutVehicleEvents(): void {
// 通过触发器自动上车
this.trigger.onEnter.add(async (chara: Character) => {
// 判断是否是玩家角色触碰的触发器,且是当前玩家。
if (chara && chara.player == await mw.Player.asyncGetLocalPlayer()) {
// 关闭角色碰撞,避免与载具发生相互作用。
chara.setCollision(CollisionStatus.Off);
// 激活交互物,让角色坐在车上。
this.interactor.enter(chara, mw.HumanoidSlotType.Buttocks, "14015");
// 设置载具的驾驶员,此时开始模拟物理,可以驾驶。
this.vehicle.owner = chara.player;
// 调整一些参数。
const handle_press_one = InputUtil.onKeyDown(Keys.One, () => {
// 按下 1 调整载具质量
this.adjustVehicleMass();
});
this.controlEventsHandle.push(handle_press_one);
const handle_press_two = InputUtil.onKeyDown(Keys.Two, () => {
// 按下 2 调整载具摩擦力系数
this.adjustVehicleFriction();
});
this.controlEventsHandle.push(handle_press_two);
const handle_press_three = InputUtil.onKeyDown(Keys.Three, () => {
// 按下 3 调整载具发动机最大转速
this.adjustVehicleMaxEngineRPM();
});
this.controlEventsHandle.push(handle_press_three);
const handle_press_four = InputUtil.onKeyDown(Keys.Four, () => {
// 按下 4 调整载具加速度
this.adjustVehicleAcceleration();
});
this.controlEventsHandle.push(handle_press_four);
const handle_press_five = InputUtil.onKeyDown(Keys.Five, () => {
// 按下 5 调整载具制动力矩
this.adjustVehicleBrakingTorque();
});
this.controlEventsHandle.push(handle_press_five);
this.VehicleKeyEvents();
}
})
// 监听下车事件。
mw.Event.addLocalListener(VehicleEvents.outOfVehicle_local, async () => {
const player = await Player.asyncGetLocalPlayer();
// 设置下车位置在触发器左边。
const outOfVehicleLoc = this.trigger.worldTransform.position.add(new Vector(0, -100, 50));
// 结束交互,角色下车。
this.interactor.leave(outOfVehicleLoc);
// 开启角色碰撞,避免掉下地面和其它碰撞不正确的问题。
player.character.setCollision(CollisionStatus.On);
// 清空载具驾驶员,此时依然会模拟物理,但无法继续控制。
this.vehicle.owner = null;
this.clearControlEvents();
})
}
// 通过按钮控制载具移动。
private VehicleKeyEvents() {
this.clearControlEvents();
//按下UP键,载具加油前进;
const handle_up_1 = InputUtil.onKeyDown(Keys.W, () => {
this.vehicle.throttleInput = 1;
});
const handle_up_0 = InputUtil.onKeyUp(Keys.W, () => {
this.vehicle.throttleInput = 0;
});
this.controlEventsHandle.push(handle_up_1, handle_up_0);
//按下Down键,载具减速后退;
const handle_down_1 = InputUtil.onKeyDown(Keys.S, () => {
this.vehicle.throttleInput = -1;
});
const handle_down_0 = InputUtil.onKeyUp(Keys.S, () => {
this.vehicle.throttleInput = 0;
});
this.controlEventsHandle.push(handle_down_1, handle_down_0);
//按下LEFT键,载具左转;
const handle_left_1 = InputUtil.onKeyDown(Keys.A, () => {
this.vehicle.steeringInput = -1;
});
const handle_left_0 = InputUtil.onKeyUp(Keys.A, () => {
this.vehicle.steeringInput = 0;
});
this.controlEventsHandle.push(handle_left_1, handle_left_0);
//按下RIGHT键,载具右转;
const handle_right_1 = InputUtil.onKeyDown(Keys.D, () => {
this.vehicle.steeringInput = 1;
});
const handle_right_0 = InputUtil.onKeyUp(Keys.D, () => {
this.vehicle.steeringInput = 0;
});
this.controlEventsHandle.push(handle_right_1, handle_right_0);
//按下SpaceBar键,载具刹车;
const handle_spaceBar_1 = InputUtil.onKeyDown(Keys.SpaceBar, () => {
this.vehicle.handbrakeInputEnable = true;
});
const handle_spaceBar_0 = InputUtil.onKeyUp(Keys.SpaceBar, () => {
this.vehicle.handbrakeInputEnable = false;
});
this.controlEventsHandle.push(handle_spaceBar_1, handle_spaceBar_0);
//按下F键,下车。
const handle_f = InputUtil.onKeyDown(Keys.F, () => {
mw.Event.dispatchToLocal(VehicleEvents.outOfVehicle_local);
});
this.controlEventsHandle.push(handle_f);
}
// 解除绑定的按钮事件。
private clearControlEvents(): void {
for (const handle of this.controlEventsHandle) {
handle.isConnected && handle.disconnect();
}
this.controlEventsHandle = [];
}
// 调整载具质量(1500与10000来回切换)。
private adjustVehicleMass(): void {
if (this.vehicle.mass == 1500) {
this.vehicle.mass = 10000;
} else {
this.vehicle.mass = 1500;
}
}
// 调整载具摩擦力系数(0.01与3来回切换)。
private adjustVehicleFriction(): void {
if (this.vehicle.friction == 3) {
this.vehicle.friction = 0.01;
} else {
this.vehicle.friction = 3;
}
}
// 调整载具发动机最大转速(1000与6000来回切换)。
private adjustVehicleMaxEngineRPM(): void {
if (this.vehicle.maxEngineRPM == 6000) {
this.vehicle.maxEngineRPM = 1000;
} else {
this.vehicle.maxEngineRPM = 6000;
}
}
// 调整载具加速度(0.1与1来回切换)。
private adjustVehicleAcceleration(): void {
if (this.vehicle.acceleration == 1) {
this.vehicle.acceleration = 0.1;
} else {
this.vehicle.acceleration = 1;
}
}
// 调整载具制动力矩(0与1500来回切换)。
private adjustVehicleBrakingTorque(): void {
if (this.vehicle.brakingTorque == 1500) {
this.vehicle.brakingTorque = 0;
} else {
this.vehicle.brakingTorque = 1500;
}
}
}
enum VehicleEvents {
createVehicle_C2S = "createVehicle_C2S",
createVehicle_S2C = "createVehicle_S2C",
outOfVehicle_local = "outOfVehicle_local",
}
@Component
export default class VehicleSample extends Script {
// 该属性暴露在属性面板中,可以方便的进行调整。
@Property({ displayName: "载具生成位置", hideInEditor: false })
private vehicleSpawnLoc: Vector = new Vector(100, 100, 200);
// 当前控制的载具。
private vehicle: AdvancedVehicle = null;
// 当前载具下面的交互物。
private interactor: Interactor = null;
// 当前载具下面的触发器,用于上下车。
private trigger: Trigger = null;
// 当前绑定的按钮事件handle,用于下车时解除绑定。
private controlEventsHandle: mw.EventListener[] = [];
// 当脚本被实例后,会在第一帧更新前调用此函数。
protected onStart(): void {
AssetUtil.asyncDownloadAsset("14015");
this.bindCreationEvents();
}
// 绑定载具创建的事件
private bindCreationEvents(): void {
if (SystemUtil.isServer()) {
mw.Event.addClientListener(VehicleEvents.createVehicle_C2S, async (player: Player) => {
// 创建载具。
this.vehicle = await mw.GameObject.asyncSpawn<mw.AdvancedVehicle> ("Vehicle4W", {
replicates: true,
transform: new Transform(this.vehicleSpawnLoc, new Rotation(0, 0, 0), new Vector(1)),
})
// 创建触发器。
this.trigger = await mw.GameObject.asyncSpawn<mw.Trigger> ("Trigger", {
replicates: true,
})
// 创建交互物。
this.interactor = await mw.GameObject.asyncSpawn<mw.Interactor>("Interactor", {
replicates: true,
})
// 创建一个Box,作为车身。
const vehicleMesh = await mw.GameObject.asyncSpawn<mw.Model>("197386", {
replicates: true,
})
// 设置父子级关系。
this.interactor.parent = this.vehicle;
this.trigger.parent = this.vehicle;
vehicleMesh.parent = this.vehicle;
// 调整相对位置,使得玩家上车时刚好坐在Box上,下车时在触发器旁边。
this.interactor.localTransform.position = new mw.Vector(0, 0, 150);
this.trigger.localTransform.position = new mw.Vector(0, -100, 0);
vehicleMesh.localTransform.position= new mw.Vector(0, 0, 50);
// 通知发起请求的客户端,载具已经创建完成。因为我们只通知了发起请求的客户端,所以每个客户端只能驾驶自己请求创建的载具。
mw.Event.dispatchToClient(player, VehicleEvents.createVehicle_S2C, [
this.vehicle.gameObjectId,
this.trigger.gameObjectId,
this.interactor.gameObjectId,
])
})
} else {
InputUtil.onKeyDown(Keys.Q, () => {
// 通过RPC调用,在服务器上动态生成载具以及触发器,交互物。
mw.Event.dispatchToServer(VehicleEvents.createVehicle_C2S);
})
// 客户端监听服务器生成完毕的消息,绑定触发器的事件,实现上下车功能。
mw.Event.addServerListener(VehicleEvents.createVehicle_S2C, async (info: string[]) => {
const [vehicleGUID, triggerGUID, interactorGUID] = info;
console.log(`vehicleGUID = [${vehicleGUID}], triggerGUID = [${triggerGUID}], interactorGUID = [${interactorGUID}]`);
this.vehicle = await GameObject.asyncFindGameObjectById(vehicleGUID) as AdvancedVehicle;
this.trigger = await GameObject.asyncFindGameObjectById(triggerGUID) as Trigger;
this.interactor = await GameObject.asyncFindGameObjectById(interactorGUID) as Interactor;
this.bindInOutVehicleEvents();
})
}
}
// 绑定触发器的事件,实现上下车功能。
private bindInOutVehicleEvents(): void {
// 通过触发器自动上车
this.trigger.onEnter.add(async (chara: Character) => {
// 判断是否是玩家角色触碰的触发器,且是当前玩家。
if (chara && chara.player == await mw.Player.asyncGetLocalPlayer()) {
// 关闭角色碰撞,避免与载具发生相互作用。
chara.setCollision(CollisionStatus.Off);
// 激活交互物,让角色坐在车上。
this.interactor.enter(chara, mw.HumanoidSlotType.Buttocks, "14015");
// 设置载具的驾驶员,此时开始模拟物理,可以驾驶。
this.vehicle.owner = chara.player;
// 调整一些参数。
const handle_press_one = InputUtil.onKeyDown(Keys.One, () => {
// 按下 1 调整载具质量
this.adjustVehicleMass();
});
this.controlEventsHandle.push(handle_press_one);
const handle_press_two = InputUtil.onKeyDown(Keys.Two, () => {
// 按下 2 调整载具摩擦力系数
this.adjustVehicleFriction();
});
this.controlEventsHandle.push(handle_press_two);
const handle_press_three = InputUtil.onKeyDown(Keys.Three, () => {
// 按下 3 调整载具发动机最大转速
this.adjustVehicleMaxEngineRPM();
});
this.controlEventsHandle.push(handle_press_three);
const handle_press_four = InputUtil.onKeyDown(Keys.Four, () => {
// 按下 4 调整载具加速度
this.adjustVehicleAcceleration();
});
this.controlEventsHandle.push(handle_press_four);
const handle_press_five = InputUtil.onKeyDown(Keys.Five, () => {
// 按下 5 调整载具制动力矩
this.adjustVehicleBrakingTorque();
});
this.controlEventsHandle.push(handle_press_five);
this.VehicleKeyEvents();
}
})
// 监听下车事件。
mw.Event.addLocalListener(VehicleEvents.outOfVehicle_local, async () => {
const player = await Player.asyncGetLocalPlayer();
// 设置下车位置在触发器左边。
const outOfVehicleLoc = this.trigger.worldTransform.position.add(new Vector(0, -100, 50));
// 结束交互,角色下车。
this.interactor.leave(outOfVehicleLoc);
// 开启角色碰撞,避免掉下地面和其它碰撞不正确的问题。
player.character.setCollision(CollisionStatus.On);
// 清空载具驾驶员,此时依然会模拟物理,但无法继续控制。
this.vehicle.owner = null;
this.clearControlEvents();
})
}
// 通过按钮控制载具移动。
private VehicleKeyEvents() {
this.clearControlEvents();
//按下UP键,载具加油前进;
const handle_up_1 = InputUtil.onKeyDown(Keys.W, () => {
this.vehicle.throttleInput = 1;
});
const handle_up_0 = InputUtil.onKeyUp(Keys.W, () => {
this.vehicle.throttleInput = 0;
});
this.controlEventsHandle.push(handle_up_1, handle_up_0);
//按下Down键,载具减速后退;
const handle_down_1 = InputUtil.onKeyDown(Keys.S, () => {
this.vehicle.throttleInput = -1;
});
const handle_down_0 = InputUtil.onKeyUp(Keys.S, () => {
this.vehicle.throttleInput = 0;
});
this.controlEventsHandle.push(handle_down_1, handle_down_0);
//按下LEFT键,载具左转;
const handle_left_1 = InputUtil.onKeyDown(Keys.A, () => {
this.vehicle.steeringInput = -1;
});
const handle_left_0 = InputUtil.onKeyUp(Keys.A, () => {
this.vehicle.steeringInput = 0;
});
this.controlEventsHandle.push(handle_left_1, handle_left_0);
//按下RIGHT键,载具右转;
const handle_right_1 = InputUtil.onKeyDown(Keys.D, () => {
this.vehicle.steeringInput = 1;
});
const handle_right_0 = InputUtil.onKeyUp(Keys.D, () => {
this.vehicle.steeringInput = 0;
});
this.controlEventsHandle.push(handle_right_1, handle_right_0);
//按下SpaceBar键,载具刹车;
const handle_spaceBar_1 = InputUtil.onKeyDown(Keys.SpaceBar, () => {
this.vehicle.handbrakeInputEnable = true;
});
const handle_spaceBar_0 = InputUtil.onKeyUp(Keys.SpaceBar, () => {
this.vehicle.handbrakeInputEnable = false;
});
this.controlEventsHandle.push(handle_spaceBar_1, handle_spaceBar_0);
//按下F键,下车。
const handle_f = InputUtil.onKeyDown(Keys.F, () => {
mw.Event.dispatchToLocal(VehicleEvents.outOfVehicle_local);
});
this.controlEventsHandle.push(handle_f);
}
// 解除绑定的按钮事件。
private clearControlEvents(): void {
for (const handle of this.controlEventsHandle) {
handle.isConnected && handle.disconnect();
}
this.controlEventsHandle = [];
}
// 调整载具质量(1500与10000来回切换)。
private adjustVehicleMass(): void {
if (this.vehicle.mass == 1500) {
this.vehicle.mass = 10000;
} else {
this.vehicle.mass = 1500;
}
}
// 调整载具摩擦力系数(0.01与3来回切换)。
private adjustVehicleFriction(): void {
if (this.vehicle.friction == 3) {
this.vehicle.friction = 0.01;
} else {
this.vehicle.friction = 3;
}
}
// 调整载具发动机最大转速(1000与6000来回切换)。
private adjustVehicleMaxEngineRPM(): void {
if (this.vehicle.maxEngineRPM == 6000) {
this.vehicle.maxEngineRPM = 1000;
} else {
this.vehicle.maxEngineRPM = 6000;
}
}
// 调整载具加速度(0.1与1来回切换)。
private adjustVehicleAcceleration(): void {
if (this.vehicle.acceleration == 1) {
this.vehicle.acceleration = 0.1;
} else {
this.vehicle.acceleration = 1;
}
}
// 调整载具制动力矩(0与1500来回切换)。
private adjustVehicleBrakingTorque(): void {
if (this.vehicle.brakingTorque == 1500) {
this.vehicle.brakingTorque = 0;
} else {
this.vehicle.brakingTorque = 1500;
}
}
}
Hierarchy
↳
AdvancedVehicle
Table of contents
Properties
vehicleLog: any |
---|
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
acceleration(): number |
---|
获取加速度。 |
brakingTorque(): number |
获取制动力矩。单位:牛米(Nm) |
currentGearLevel(): number |
获取当前档位级别。 |
driveMode(): VehicleDriveMode4WNew |
获取载具驱动模式。 |
friction(): number |
获取载具摩擦力系数。 |
handbrakeInputEnable(useHandbrake : boolean ): void |
是否进行手刹,true-进行制动, false-取消制动。 |
mass(): number |
获取质量。 |
maxEngineRPM(): number |
获取最大发动机转速。单位:转/分(r/min) |
maxGearLevel(): number |
获取最大档位级别。如返回值为4,则表示有[-1, 0, 1, 2, 3, 4]这些档位。 |
owner(): Player other |
获取载具驾驶员。 |
simulatePhysics(shouldSimulate : boolean ): void |
设置四轮载具是否开启物理模拟计算,需要在客户端调用。 |
steeringInput(newInput : number ): void |
控制载具左/右转向,设置转向幅度,取值范围[-1,1],大于0时右转,小于0则左转。 |
throttleInput(newInput : number ): void |
控制载具前进/后退,设置油门大小,取值范围[-1,1],大于0时加速,小于0则减速。 |
velocity(): number |
获取当前行驶速度,单位:米/秒(m/s)。 |
wheelNum(): number |
获取车轮数量。 |
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
gearDown(): void |
---|
降一档,立即切换。 |
gearUp(): void |
升一档,立即切换。 |
getGearData(gearLevel : number ): VehicleGearDataNew |
获取指定档位属性 |
getWheelMaxSteerAngle(wheelId : number ): number |
获取车轮最大转向角度,单位:度(°)。 |
getWheelModel(wheelId : number ): string |
获取轮胎绑定对象。 |
getWheelRadius(wheelId : number ): number |
获取车轮半径,单位:厘米(cm)。 |
onDestroy(): void |
销毁 |
setCullDistance(inCullDistance : number ): void |
与玩家之间超出此距离的对象将被剪裁,最终的裁剪距离会和画质等级有关;修改此属性≤0时,裁剪距离会根据对象尺寸自动调整(自动启用CullDistanceVolume功能) |
setWheelRadius(wheelId : number , Radius : number ): void |
设置车轮半径,单位:厘米(cm)。 |
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
vehicleLog
• Private
vehicleLog: any
------------------------------------------ 内部属性/函数 ------------------------------------------
Accessors
acceleration
• | • | ||||
---|---|---|---|---|---|
获取加速度。 Returns
| 设置加速度。
[0.01, 100] Parameters
|
brakingTorque
• | • | ||||
---|---|---|---|---|---|
获取制动力矩。单位:牛米(Nm) 车辆制动力矩是指应用于车辆制动系统的力矩,用于减速或停止车辆运动。它是制动系统产生的力矩,通过制动器(如刹车盘和刹车片)施加到车轮上,从而减少车轮的旋转速度。 Returns
| 设置制动力矩。单位:牛米(Nm)
[0, 1000000] Parameters
|
currentGearLevel
• | • | ||||
---|---|---|---|---|---|
获取当前档位级别。 Returns
| 设置当前档位级别。
[-1, 设定的最大档位] Precautions
Parameters
|
driveMode
• | ||
---|---|---|
获取载具驱动模式。 Returns
|
friction
• | • | ||||
---|---|---|---|---|---|
获取载具摩擦力系数。 Returns
| 设置载具车轮摩擦力系数
[0.01, 8] Parameters
|
handbrakeInputEnable
• | ||
---|---|---|
是否进行手刹,true-进行制动, false-取消制动。 Precautions 输入值发生变化时,调用一次即可。输入值会保持,不需要持续调用。 Parameters
|
mass
• | • | ||||
---|---|---|---|---|---|
获取质量。 Returns
| 设置载具质量,单位:千克(kg)。
[0.01, 100000] Precautions
Parameters
|
maxEngineRPM
• | • | ||||
---|---|---|---|---|---|
获取最大发动机转速。单位:转/分(r/min) Returns
| 设置最大发动机转速。单位:转/分(r/min)
[100, 5000000] Parameters
|
maxGearLevel
• | ||
---|---|---|
获取最大档位级别。如返回值为4,则表示有[-1, 0, 1, 2, 3, 4]这些档位。 Precautions 最大可切换到的档位。如获取当前档位,请使用getCurrentGearLevel Returns
|
owner
• | • | ||||
---|---|---|---|---|---|
获取载具驾驶员。 Returns
| 设置载具驾驶员。只有驾驶员才可以操作载具。 Parameters
|
simulatePhysics
• | ||
---|---|---|
设置四轮载具是否开启物理模拟计算,需要在客户端调用。 Precautions 四轮载具只在set owner成功后才会进行物理模拟。此时关闭物理模拟将无法继续驱动载具移动。 Parameters
|
steeringInput
• | ||
---|---|---|
控制载具左/右转向,设置转向幅度,取值范围[-1,1],大于0时右转,小于0则左转。
[-1, 1],大于0时右转,小于0则左转。 Precautions
Parameters
|
ts
// 通过按钮控制载具油门
this.btn_forward.onPressed.add(() => {
vehicle.setThrottleInput(1);
})
this.btn_forward.onReleased.add(() => {
vehicle.setThrottleInput(0);
})
// 通过摇杆控制载具,摇杆会同时提供两个轴向(x, y)的输入
this.joystick.onInputDir.add((vec: mw.Vector2) => {
// 控制油门
vehicle.setThrottleInput(vec.y);
// 控制转向
vehicle.setSteeringInput(vec.x);
})
// 通过按钮控制载具油门
this.btn_forward.onPressed.add(() => {
vehicle.setThrottleInput(1);
})
this.btn_forward.onReleased.add(() => {
vehicle.setThrottleInput(0);
})
// 通过摇杆控制载具,摇杆会同时提供两个轴向(x, y)的输入
this.joystick.onInputDir.add((vec: mw.Vector2) => {
// 控制油门
vehicle.setThrottleInput(vec.y);
// 控制转向
vehicle.setSteeringInput(vec.x);
})
throttleInput
• | ||
---|---|---|
控制载具前进/后退,设置油门大小,取值范围[-1,1],大于0时加速,小于0则减速。
[-1, 1],大于0时加速,小于0则减速。 Precautions
Parameters
|
ts
// 通过按钮控制载具油门
this.btn_forward.onPressed.add(() => {
vehicle.throttleInput = 1;
})
this.btn_forward.onReleased.add(() => {
vehicle.throttleInput = 0;
})
// 通过摇杆控制载具,摇杆会同时提供两个轴向(x, y)的输入
this.joystick.onInputDir.add((vec: mw.Vector2) => {
// 控制油门
vehicle.throttleInput = vec.y;
// 控制转向
vehicle.steeringInput = vec.x;
})
// 通过按钮控制载具油门
this.btn_forward.onPressed.add(() => {
vehicle.throttleInput = 1;
})
this.btn_forward.onReleased.add(() => {
vehicle.throttleInput = 0;
})
// 通过摇杆控制载具,摇杆会同时提供两个轴向(x, y)的输入
this.joystick.onInputDir.add((vec: mw.Vector2) => {
// 控制油门
vehicle.throttleInput = vec.y;
// 控制转向
vehicle.steeringInput = vec.x;
})
velocity
• | ||
---|---|---|
获取当前行驶速度,单位:米/秒(m/s)。 Returns
|
wheelNum
• |
---|
获取车轮数量。 Returns |
number | 车轮数量 |
---|
Methods
gearDown
• gearDown(): void
降一档,立即切换。
gearUp
• gearUp(): void
升一档,立即切换。
getGearData
• getGearData(gearLevel
): VehicleGearDataNew
获取指定档位属性
Parameters
gearLevel number | 指定档位级别 range: [0, 1] type: 浮点数 |
---|
Returns
VehicleGearDataNew | 指定档位属性 |
---|
Precautions
注意输入参数的取值范围
getWheelMaxSteerAngle
• getWheelMaxSteerAngle(wheelId
): number
获取车轮最大转向角度,单位:度(°)。
Parameters
wheelId number | 根据序号指定车轮 range: 0.1.2.3 四个参数 type:整数 |
---|
Returns
number | 指定车轮最大转向角度 |
---|
注意输入参数的取值范围。当前为四轮载具,[0, 1, 2, 3]分别对应[左前, 右前, 左后, 右后]。
getWheelModel
• getWheelModel(wheelId
): string
获取轮胎绑定对象。
Parameters
wheelId number | 根据序号指定车轮 range: 0.1.2.3 四个参数 type:整数 |
---|
Returns
string | 指定轮胎绑定对象GUID |
---|
注意输入参数的取值范围。当前为四轮载具,[0, 1, 2, 3]分别对应[左前, 右前, 左后, 右后]。
getWheelRadius
• getWheelRadius(wheelId
): number
获取车轮半径,单位:厘米(cm)。
Parameters
wheelId number | 根据序号指定车轮 range: 0.1.2.3 四个参数 type:整数 |
---|
Returns
number | 指定车轮半径 |
---|
注意输入参数的取值范围。当前为四轮载具,[0, 1, 2, 3]分别对应[左前, 右前, 左后, 右后]。
onDestroy
• Protected
onDestroy(): void
销毁
setCullDistance
• setCullDistance(inCullDistance
): void
与玩家之间超出此距离的对象将被剪裁,最终的裁剪距离会和画质等级有关;修改此属性≤0时,裁剪距离会根据对象尺寸自动调整(自动启用CullDistanceVolume功能)
Parameters
inCullDistance number | 裁剪距离 range: 建议 (2000, 4000) type: 浮点数 |
---|
Precautions
最终的裁剪距离会和画质等级有关
setWheelRadius
• setWheelRadius(wheelId
, Radius
): void
设置车轮半径,单位:厘米(cm)。
Parameters
wheelId number | 根据序号指定车轮 range: 0.1.2.3 四个参数 type:整数 |
---|---|
Radius number | 指定车轮半径 range:不做限制,合理即可 type: 浮点数 |
注意输入参数的取值范围。当前为四轮载具,[0, 1, 2, 3]分别对应[左前, 右前, 左后, 右后]。仅在上车前生效,上车后调用此接口无效果。