神岛 API 文档 - ArenaPro版
    Preparing search index...

    Class GamePlayer

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

    A player corresponds to a user connected to the game. Each player object represents a connected user and can contain detailed information such as username, score, character, etc.

    Index

    Admin

    kick

    Animation

    animate getAnimations

    Camera

    cameraDistance cameraEntity cameraFovY cameraFreezedAxis cameraMode cameraPosition cameraTarget cameraUp setCameraPitch setCameraYaw

    Chat

    directMessage muted nextChat onChat

    Dialog

    cancelDialogs dialog

    Display

    addWearable clearSkin color emissive invisible metalness removeWearable resetToDefaultSkin setSkinByName shininess showIndicator showName skin skinInvisible wearables

    Economy

    getMiaoShells

    Health

    dead forceRespawn nextRespawn onRespawn

    Input

    action0Button action1Button cameraPitch cameraYaw crouchButton disableInputDirection enable3DCursor enableAction0 enableAction1 enableCrouch enableDoubleJump enableJump facingDirection jumpButton nextPress nextRelease onKeyDown onKeyUp onPress onRelease reverseInputDirection swapInputDirection walkButton

    Movement

    canFly crouchAcceleration crouchSpeed doubleJumpPower flyAcceleration flySpeed freezedForwardDirection jumpAccelerationFactor jumpPower jumpSpeedFactor runAcceleration runSpeed spectator swimAcceleration swimSpeed walkAcceleration walkSpeed

    Other

    avatar boxId colorLUT gamepad name navigator url userId userKey

    Social

    openUserProfileDialog querySocial querySocialStatistic

    Sound

    action0Sound action1Sound crouchSound doubleJumpSound enterWaterSound jumpSound landSound leaveWaterSound music sound spawnSound startFlySound stepSound stopFlySound swimSound

    Spawn

    movementBounds spawnPoint

    State

    moveState walkState

    Web

    link openMarketplace share

    显示

    scale

    Admin

    kick: () => void

    将用户踢出服务器。

    Kicks the user from the server.

    Animation

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

    播放动画。

    Plays an animation.

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

    获取当前播放的所有动画。

    Gets all currently playing animations.

    Camera

    cameraDistance: number

    摄像机距离。

    The camera distance.

    cameraEntity: GameEntity

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

    The entity that the player's camera follows in FPS or FOLLOW mode.

    cameraFovY: number

    摄像机视场角Y。

    The camera field of view Y.

    cameraFreezedAxis: GameCameraFreezedAxis

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

    The frozen camera axis in RELATIVE mode.

    cameraMode: GameCameraMode

    摄像机行为模式。

    Camera behavior mode.

    • "FPS" -

    第一人称摄像机

    First-person camera

    • "FOLLOW" -

    第三人称跟随摄像机（默认）

    Third-person follow camera (default)

    • "FIXED" -

    第三人称固定摄像机

    Third-person fixed camera

    • "RELATIVE" -

    相对玩家位置的第三人称摄像机

    Third-person camera relative to player position

    cameraPosition: GameVector3

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

    The camera eye position in FIXED mode.

    cameraTarget: GameVector3

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

    The camera target point in FIXED mode.

    cameraUp: GameVector3

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

    The camera up vector in FIXED mode.

    setCameraPitch: (value: number) => void

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

    Sets the vertical rotation angle of the camera.

    setCameraYaw: (value: number) => void

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

    Sets the horizontal rotation angle of the camera.

    Chat

    directMessage: (message: string) => void

    向玩家发送私聊消息。

    Sends a direct message to the player.

    muted: boolean

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

    If true, the player cannot chat.

    当前未使用。

    Currently unused.

    nextChat: GameEventFuture<GameChatEvent>

    获取下一个聊天事件。

    Gets the next chat event.

    onChat: GameEventChannel<GameChatEvent>

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

    Called when the player initiates a chat event.

    Dialog

    cancelDialogs: () => void

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

    Cancels all open dialogs for the player.

    Display

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

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

    Adds a new wearable item to the player.

    clearSkin: () => void

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

    Clears the player's custom skin and restores the character's skin.

    color: GameRGBColor

    颜色。

    Color.

    emissive: number

    发光强度。

    Emissive intensity.

    invisible: boolean

    是否隐身。

    Whether the player is invisible.

    metalness: number

    金属度。

    Metalness.

    removeWearable: (wearable: GameWearable) => void

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

    Removes a wearable item from the player.

    要移除的可穿戴物品。

    The wearable item to remove.

    resetToDefaultSkin: () => void

    将玩家重置为默认皮肤。

    Resets the player to the default skin.

    setSkinByName: (skinName: string) => void

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

    Sets the player's skin by skin name.

    shininess: number

    光泽度。

    Shininess.

    showIndicator: boolean

    是否显示指示器。

    Whether to show the indicator.

    showName: boolean

    是否显示名称。

    Whether to show the name.

    skin: GameSkin

    皮肤部件。

    Skin components.

    skinInvisible: GameSkinInvisible

    皮肤部件是否不可见。

    Whether skin components are invisible.

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

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

    Lists all wearable items on the player.

    是一个可选过滤器，用于显示特定身体部位上的可穿戴物品。

    An optional filter to display wearable items on a specific body part.

    Economy

    getMiaoShells: () => Promise<number>

    获取玩家的喵币数量。

    Gets the player's Miao Shells count.

    Health

    dead: boolean

    是否死亡。

    Whether the player is dead.

    forceRespawn: () => void

    强制玩家重生。

    Forces the player to respawn.

    nextRespawn: GameEventFuture<GameRespawnEvent>

    获取下一个重生事件。

    Gets the next respawn event.

    onRespawn: GameEventChannel<GameRespawnEvent>

    当玩家重生时调用。

    Called when the player respawns.

    Input

    action0Button: boolean

    是否按下了鼠标左键 / 虚拟按钮A按钮。

    Whether the action 0 button is pressed.

    action1Button: boolean

    是否按下了鼠标右键 / 虚拟按钮B按钮。

    Whether the action 1 button is pressed.

    cameraPitch: number

    摄像机垂直旋转角度。

    Camera vertical rotation angle.

    cameraYaw: number

    摄像机水平旋转角度。

    Camera horizontal rotation angle.

    crouchButton: boolean

    是否按下了蹲下按钮。

    Whether the crouch button is pressed.

    disableInputDirection: GameInputDirection

    禁用的输入方向。

    Disabled input direction.

    enable3DCursor: boolean

    是否启用3D光标。

    Whether 3D cursor is enabled.

    enableAction0: boolean

    如果为true，启用玩家输入按钮鼠标左键 / 虚拟按钮A。

    If true, enables player input button action 0.

    enableAction1: boolean

    如果为true，启用玩家输入按钮鼠标右键 / 虚拟按钮B。

    If true, enables player input button action 1.

    enableCrouch: boolean

    是否启用蹲下。

    Whether crouching is enabled.

    enableDoubleJump: boolean

    是否启用双重跳跃。

    Whether double jumping is enabled.

    enableJump: boolean

    是否启用跳跃。

    Whether jumping is enabled.

    facingDirection: GameVector3

    面向方向。

    Facing direction.

    jumpButton: boolean

    是否按下了跳跃按钮。

    Whether the jump button is pressed.

    nextPress: GameEventFuture<GameInputEvent>

    获取下一个按键按下事件。

    Gets the next button press event.

    nextRelease: GameEventFuture<GameInputEvent>

    获取下一个按键释放事件。

    Gets the next button release event.

    onKeyDown: GameEventChannel<GameKeyBoardEvent>

    当玩家按下键盘键时调用。

    Called when the player presses a keyboard key.

    onKeyUp: GameEventChannel<GameKeyBoardEvent>

    当玩家释放键盘键时调用。

    Called when the player releases a keyboard key.

    onPress: GameEventChannel<GameInputEvent>

    当玩家按下按钮时调用。

    Called when the player presses a button.

    onRelease: GameEventChannel<GameInputEvent>

    当玩家释放按钮时调用。

    Called when the player releases a button.

    reverseInputDirection: GameInputDirection

    反转输入方向。

    Reverse input direction.

    swapInputDirection: boolean

    是否交换输入方向。

    Whether to swap input directions.

    walkButton: boolean

    是否按下了行走按钮。

    Whether the walk button is pressed.

    Movement

    canFly: boolean

    如果为true，允许玩家飞行。

    If true, allows the player to fly.

    crouchAcceleration: number

    蹲下行走加速度。

    Crouching walking acceleration.

    crouchSpeed: number

    蹲下行走速度。

    Crouching walking speed.

    doubleJumpPower: number

    双重跳跃速度冲量。

    Double jump power impulse.

    flyAcceleration: number

    飞行加速度。

    Flying acceleration.

    flySpeed: number

    最大飞行速度。

    Maximum flying speed.

    freezedForwardDirection: GameVector3

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

    The frozen forward direction in RELATIVE mode.

    jumpAccelerationFactor: number

    跳跃加速度率。

    Jump acceleration factor.

    jumpPower: number

    跳跃速度冲量。

    Jump power impulse.

    jumpSpeedFactor: number

    跳跃速度因子。

    Jump speed factor.

    runAcceleration: number

    跑步加速度。

    Running acceleration.

    runSpeed: number

    最大跑步速度。

    Maximum running speed.

    spectator: boolean

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

    If true, the player is a ghost and can pass through walls.

    swimAcceleration: number

    游泳加速度。

    Swimming acceleration.

    swimSpeed: number

    最大游泳速度。

    Maximum swimming speed.

    walkAcceleration: number

    步行加速度。

    Walking acceleration.

    walkSpeed: number

    最大步行速度。

    Maximum walking speed.

    Other

    avatar: string

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

    The player's avatar if logged in.

    boxId: string

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

    The player's Box user ID if logged in.

    colorLUT: string

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

    Color lookup table applied to the player to adjust game state colors.

    gamepad: Gamepad

    设置虚拟按键图片。

    Sets the virtual button images.

    name: string

    玩家名称。常量。

    The player's name. Constant.

    navigator: PlayerNavigator

    导航器。

    Navigator.

    url: URL

    玩家 URL。

    The player's URL.

    userId: string

    登录玩家的用户ID。

    The logged-in user's ID.

    userKey: string

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

    The unique user key for this player. Can be used to save their information in a database.

    Social

    openUserProfileDialog: (userId: number) => void

    打开用户个人资料对话框。

    Opens the user profile dialog.

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

    查询用户的社交关系。

    Queries the user's social relationships.

    querySocialStatistic: () => Promise<SocialStatisticType>

    查询用户的社交统计信息。

    Queries the user's social statistics.

    Sound

    action0Sound: GameSoundEffect

    玩家按下鼠标左键 / 虚拟按钮A按钮时播放的声音。

    Sound played when the player presses action 0 button.

    action1Sound: GameSoundEffect

    玩家按下鼠标右键 / 虚拟按钮B按钮时播放的声音。

    Sound played when the player presses action 1 button.

    crouchSound: GameSoundEffect

    玩家蹲下时播放的声音。

    Sound played when the player crouches.

    doubleJumpSound: GameSoundEffect

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

    Sound played when the player double jumps.

    enterWaterSound: GameSoundEffect

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

    Sound played when the entity enters water.

    jumpSound: GameSoundEffect

    玩家跳跃时播放的声音。

    Sound played when the player jumps.

    landSound: GameSoundEffect

    玩家落地时播放的声音。

    Sound played when the player lands.

    leaveWaterSound: GameSoundEffect

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

    Sound played when the entity leaves water.

    music: GameSoundEffect

    玩家的背景音乐。

    The player's background music.

    sound: (spec: any) => Sound

    为玩家播放声音。

    Plays a sound for the player.

    spawnSound: GameSoundEffect

    玩家重生时播放的声音。

    Sound played when the player respawns.

    startFlySound: GameSoundEffect

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

    Sound played when the player starts flying.

    stepSound: GameSoundEffect

    玩家行走时播放的脚步声。

    Footstep sound played when the player walks.

    stopFlySound: GameSoundEffect

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

    Sound played when the player stops flying.

    swimSound: GameSoundEffect

    玩家游泳时播放的声音。

    Sound played when the player swims.

    Spawn

    movementBounds: GameBounds3

    移动边界。

    Movement bounds.

    spawnPoint: GameVector3

    玩家的初始生成点。

    The player's initial spawn point.

    State

    moveState: GamePlayerMoveState

    移动状态。

    Movement state.

    walkState: GamePlayerWalkState

    行走状态。

    Walking state.

    Web

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

    在客户端打开一个超链接。

    Opens a hyperlink on the client side.

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

    打开商品购买对话框。

    Opens the product purchase dialog.

    share: (content: string) => void

    打开分享模态框。

    Opens the share modal.

    显示

    scale: number

    缩放比例。

    Scale factor.

    Settings

    Member Visibility

    On This Page

    Admin
    Animation
    Camera
    Chat
    Dialog
    Display
    Economy
    Health
    Input
    Movement
    Other
    Social
    Sound
    Spawn
    State
    Web
    显示