Class GamePlayer

玩家对应于连接到游戏的用户。每个玩家对象代表一个已连接的用户，可以包含玩家的详细信息，如用户名、得分、角色等。

Index

Other

avatar boxId colorLUT gamepad name navigator url userId userKey

动画

Other

avatar

avatar: string

如果已登录，则为玩家的头像。

boxId

boxId: string

如果已登录，则为玩家的用户ID。

colorLUT

colorLUT: string

颜色分级查找表，应用于玩家以调整游戏状态的颜色

gamepad

gamepad: Gamepad

设置虚拟按键图片

name

name: string

玩家名称。常量。

navigator

navigator: PlayerNavigator

导航器

url

url: URL

玩家URL

userId

userId: string

登录玩家的用户ID

userKey

userKey: string

此玩家的唯一用户密钥。可用于将他们的信息保存到数据库中。

动画

animate

animate: (
keyframes: Partial<GamePlayerKeyframe>[],
playbackConfig?: GameAnimationPlaybackConfig,
) => GameAnimation<GamePlayerKeyframe, GamePlayer>

播放动画

getAnimations

getAnimations: () => GameAnimation<GamePlayerKeyframe, GamePlayer>[]

获取当前播放的所有动画

声音

action0Sound

action0Sound: GameSoundEffect

玩家按下动作0按钮时播放的声音

action1Sound

action1Sound: GameSoundEffect

玩家按下动作1按钮时播放的声音

crouchSound

crouchSound: GameSoundEffect

玩家蹲下时播放的声音

doubleJumpSound

doubleJumpSound: GameSoundEffect

玩家双重跳跃时播放的声音

enterWaterSound

enterWaterSound: GameSoundEffect

实体进入水中时播放的声音

jumpSound

jumpSound: GameSoundEffect

玩家跳跃时播放的声音

landSound

landSound: GameSoundEffect

玩家落地时播放的声音

leaveWaterSound

leaveWaterSound: GameSoundEffect

实体离开水中时播放的声音

music

music: GameSoundEffect

玩家的背景音乐

sound

sound: (spec: any) => Sound

为玩家播放声音

spawnSound

spawnSound: GameSoundEffect

玩家重生时播放的声音

startFlySound

startFlySound: GameSoundEffect

玩家开始飞行时播放的声音

stepSound

stepSound: GameSoundEffect

玩家行走时播放的脚步声

stopFlySound

stopFlySound: GameSoundEffect

玩家停止飞行时播放的声音

swimSound

swimSound: GameSoundEffect

玩家游泳时播放的声音

对话

cancelDialogs

cancelDialogs: () => void

取消玩家的所有打开的对话框

dialog

dialog<
    T extends
        GameTextDialogParams
        | GameSelectDialogParams
        | GameInputDialogParams,
>(
    params: T,
): T extends GameSelectDialogParams
    ? Promise<GameDialogSelectResponse>
    : Promise<string>
为玩家打开一个对话框
Type Parameters
- T extends GameTextDialogParams | GameSelectDialogParams | GameInputDialogParams
Parameters
- params: T
  对话框参数，可以是 GameInputDialogParams、GameTextDialogParams 或 GameSelectDialogParams 中的一种。
Returns T extends GameSelectDialogParams
? Promise<GameDialogSelectResponse>
: Promise<string>
如果参数类型为 GameSelectDialogParams，则返回 GameDialogSelectResponse 或 null 的 Promise；否则，返回 string 或 null 的 Promise。
- Defined in server/types/GameAPI.d.ts:13347
dialog(params: GameInputDialogParams): Promise<string>
为玩家打开一个对话框
Parameters
- params: GameInputDialogParams
  对话框参数，可以是 GameInputDialogParams、GameTextDialogParams 或 GameSelectDialogParams 中的一种。
Returns Promise<string>
如果参数类型为 GameSelectDialogParams，则返回 GameDialogSelectResponse 或 null 的 Promise；否则，返回 string 或 null 的 Promise。
- Defined in server/types/GameAPI.d.ts:13357
dialog(params: GameTextDialogParams): Promise<string>
为玩家打开一个对话框
Parameters
- params: GameTextDialogParams
  对话框参数，可以是 GameInputDialogParams、GameTextDialogParams 或 GameSelectDialogParams 中的一种。
Returns Promise<string>
如果参数类型为 GameSelectDialogParams，则返回 GameDialogSelectResponse 或 null 的 Promise；否则，返回 string 或 null 的 Promise。
- Defined in server/types/GameAPI.d.ts:13358
dialog(params: GameSelectDialogParams): Promise<GameDialogSelectResponse>
为玩家打开一个对话框
Parameters
- params: GameSelectDialogParams
  对话框参数，可以是 GameInputDialogParams、GameTextDialogParams 或 GameSelectDialogParams 中的一种。
Returns Promise<GameDialogSelectResponse>
如果参数类型为 GameSelectDialogParams，则返回 GameDialogSelectResponse 或 null 的 Promise；否则，返回 string 或 null 的 Promise。
- Defined in server/types/GameAPI.d.ts:13359

摄像机

cameraDistance

cameraDistance: number

摄像机距离

cameraEntity

cameraEntity: GameEntity

在FPS或FOLLOW模式下，玩家摄像机跟随的实体

cameraFovY

cameraFovY: number

摄像机视场角Y

cameraFreezedAxis

cameraFreezedAxis: GameCameraFreezedAxis

在RELATIVE模式下冻结的摄像机轴

cameraMode

cameraMode: GameCameraMode

摄像机行为模式。

"FPS" - 第一人称摄像机
"FOLLOW" - 第三人称跟随摄像机（默认）
"FIXED" - 第三人称固定摄像机
"RELATIVE" - 相对玩家位置的第三人称摄像机

cameraPosition

cameraPosition: GameVector3

在FIXED模式下的摄像机眼睛位置

cameraTarget

cameraTarget: GameVector3

在FIXED模式下的摄像机目标点

cameraUp

cameraUp: GameVector3

在FIXED模式下的摄像机上向量

setCameraPitch

setCameraPitch: (value: number) => void

设置摄像机的垂直旋转角度

setCameraYaw

setCameraYaw: (value: number) => void

设置摄像机的水平旋转角度

显示

addWearable

addWearable: (spec: Partial<GameWearable>) => GameWearable

为玩家添加一个新的可穿戴物品

clearSkin

clearSkin: () => void

清除玩家自定义皮肤并恢复到角色皮肤

color

color: GameRGBColor

颜色

emissive

emissive: number

发光强度

invisible

invisible: boolean

是否隐身

metalness

metalness: number

金属度

removeWearable

removeWearable: (wearable: GameWearable) => void

从玩家身上移除一个可穿戴物品

Type declaration

- (wearable: GameWearable): void
- Parameters
  - wearable: GameWearable
    要移除的可穿戴物品
  Returns void

resetToDefaultSkin

resetToDefaultSkin: () => void

将玩家重置为默认皮肤

scale

scale: number

缩放比例

setSkinByName

setSkinByName: (skinName: string) => void

通过皮肤名称设置玩家皮肤

shininess

shininess: number

光泽度

showIndicator

showIndicator: boolean

是否显示指示器

showName

showName: boolean

是否显示名称

skin

skin: GameSkin

皮肤部件

skinInvisible

skinInvisible: GameSkinInvisible

皮肤部件是否不可见

wearables

wearables: (bodyPart?: GameBodyPart) => GameWearable[]

列出玩家身上所有可穿戴物品

Type declaration

- (bodyPart?: GameBodyPart): GameWearable[]
- Parameters
  - OptionalbodyPart: GameBodyPart
    是一个可选过滤器，用于显示特定身体部位上的可穿戴物品
  Returns GameWearable[]

状态

moveState

moveState: GamePlayerMoveState

移动状态

walkState

walkState: GamePlayerWalkState

行走状态

生命值

dead

dead: boolean

是否死亡

forceRespawn

forceRespawn: () => void

强制玩家重生

nextRespawn

nextRespawn: GameEventFuture<GameRespawnEvent>

获取下一个重生事件

onRespawn

onRespawn: GameEventChannel<GameRespawnEvent>

当玩家重生时调用

生成

movementBounds

movementBounds: GameBounds3

移动边界

spawnPoint

spawnPoint: GameVector3

玩家的初始生成点

社交

openUserProfileDialog

openUserProfileDialog: (userId: number) => void

打开用户个人资料对话框

querySocial

querySocial: (socialType: SocialType) => Promise<number[]>

查询用户的社交关系

querySocialStatistic

querySocialStatistic: () => Promise<SocialStatisticType>

查询用户的社交统计信息

移动

canFly

canFly: boolean

如果为true，允许玩家飞行

crouchAcceleration

crouchAcceleration: number

蹲下行走加速度

crouchSpeed

crouchSpeed: number

蹲下行走速度

doubleJumpPower

doubleJumpPower: number

双重跳跃速度冲量

flyAcceleration

flyAcceleration: number

飞行加速度

flySpeed

flySpeed: number

最大飞行速度

freezedForwardDirection

freezedForwardDirection: GameVector3

在RELATIVE模式下冻结的前向方向

jumpAccelerationFactor

jumpAccelerationFactor: number

跳跃加速度率

jumpPower

jumpPower: number

跳跃速度冲量

jumpSpeedFactor

jumpSpeedFactor: number

跳跃速度因子

runAcceleration

runAcceleration: number

跑步加速度

runSpeed

runSpeed: number

最大跑步速度

spectator

spectator: boolean

如果为true，玩家是幽灵，可以穿过墙壁

swimAcceleration

swimAcceleration: number

游泳加速度

swimSpeed

swimSpeed: number

最大游泳速度

walkAcceleration

walkAcceleration: number

步行加速度

walkSpeed

walkSpeed: number

最大步行速度

管理

kick

kick: () => void

将用户踢出服务器

经济

getMiaoShells

getMiaoShells: () => Promise<number>

获取玩家的喵币数量

网页

link

link: (
href: string,
options?: { isConfirm?: boolean; isNewTab?: boolean },
) => void

在客户端打开一个超链接

openMarketplace

openMarketplace: (productIds: number[]) => void

打开商品购买对话框

share: (content: string) => void

打开分享模态框

聊天

directMessage

directMessage: (message: string) => void

向玩家发送私聊消息

muted

muted: boolean

如果为true，则玩家不能聊天

Deprecated

当前未使用

nextChat

nextChat: GameEventFuture<GameChatEvent>

获取下一个聊天事件

onChat

onChat: GameEventChannel<GameChatEvent>

当玩家发起聊天事件时调用

输入

action0Button

action0Button: boolean

是否按下了动作0按钮

action1Button

action1Button: boolean

是否按下了动作1按钮

cameraPitch

cameraPitch: number

摄像机垂直旋转角度

cameraYaw

cameraYaw: number

摄像机水平旋转角度

crouchButton

crouchButton: boolean

是否按下了蹲下按钮

disableInputDirection

disableInputDirection: GameInputDirection

禁用的输入方向

enable3DCursor

enable3DCursor: boolean

是否启用3D光标

enableAction0

enableAction0: boolean

如果为true，启用玩家输入按钮动作0

enableAction1

enableAction1: boolean

如果为true，启用玩家输入按钮动作1

enableCrouch

enableCrouch: boolean

是否启用蹲下

enableDoubleJump

enableDoubleJump: boolean

是否启用双重跳跃

enableJump

enableJump: boolean

是否启用跳跃

facingDirection

facingDirection: GameVector3

面向方向

jumpButton

jumpButton: boolean

是否按下了跳跃按钮

nextPress

nextPress: GameEventFuture<GameInputEvent>

获取下一个按键按下事件

nextRelease

nextRelease: GameEventFuture<GameInputEvent>

获取下一个按键释放事件

onKeyDown

onKeyDown: GameEventChannel<GameKeyBoardEvent>

当玩家按下或释放键盘键时调用

onKeyUp

onKeyUp: GameEventChannel<GameKeyBoardEvent>

当玩家释放键盘键时调用

onPress

onPress: GameEventChannel<GameInputEvent>

当玩家按下按钮时调用

onRelease

onRelease: GameEventChannel<GameInputEvent>

当玩家释放按钮时调用

reverseInputDirection

reverseInputDirection: GameInputDirection

反转输入方向

swapInputDirection

swapInputDirection: boolean

是否交换输入方向

walkButton

walkButton: boolean

是否按下了行走按钮

Class GamePlayer

Index

Other

动画

声音

对话

摄像机

显示

状态

生命值

生成

社交

移动

管理

经济

网页

聊天

输入

Other

avatar

boxId

colorLUT

gamepad

name

navigator

url

userId

userKey

动画

animate

getAnimations

声音

action0Sound

action1Sound

crouchSound

doubleJumpSound

enterWaterSound

jumpSound

landSound

leaveWaterSound

music

sound

spawnSound

startFlySound

stepSound

stopFlySound

swimSound

对话

cancelDialogs

dialog

Type Parameters

Parameters

Returns T extends GameSelectDialogParams ? Promise<GameDialogSelectResponse> : Promise<string>

Parameters

Returns Promise<string>

Parameters

Returns Promise<string>

Parameters

Returns Promise<GameDialogSelectResponse>

摄像机

cameraDistance

cameraEntity

cameraFovY

cameraFreezedAxis

cameraMode

cameraPosition

cameraTarget

cameraUp

setCameraPitch

setCameraYaw

显示

addWearable

clearSkin

color

emissive

invisible

metalness

removeWearable

Type declaration

Parameters

Returns T extends GameSelectDialogParams
? Promise<GameDialogSelectResponse>
: Promise<string>