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

    Class GameEntity

    实体是游戏中的游戏对象，可以用来表示玩家、物体等。

    Implements

    Index

    Other

    constructor animate getAnimations nextClick nextDestroy nextDie nextEntityContact nextEntitySeparate nextFluidEnter nextFluidLeave nextInteract nextTakeDamage nextVoxelContact nextVoxelSeparate onClick

    chat

    say

    destroy

    destroy destroyed onDestroy

    entityName

    customName nameColor nameRadius showEntityName

    health

    enableDamage hp hurt maxHp onDie onTakeDamage showHealthBar

    interact

    enableInteract interactColor interactHint interactRadius

    interactive

    onInteract

    mesh

    anchorOffset lookAt mesh meshColor meshEmissive meshInvisible meshMetalness meshOffset meshOrientation meshScale meshShininess rotateLocal scaleLocal

    motion

    motion

    particle

    particleAcceleration particleColor particleDamping particleLifetime particleLifetimeSpread particleLimit particleNoise particleNoiseFrequency particleRate particleRateSpread particleSize particleSizeSpread particleTarget particleTargetWeight particleVelocity particleVelocitySpread

    physics

    bounds collides contactForce entityContacts fixed fluidContacts friction gravity mass onEntityContact onEntitySeparate onFluidEnter onFluidLeave onVoxelContact onVoxelSeparate position restitution velocity voxelContacts

    player

    isPlayer player

    selectors

    addTag hasTag id removeTag tags

    sound

    chatSound dieSound hurtSound interactSound sound

    Other

    animate: (
        keyframes: Partial<GameEntityKeyframe>[],
        playbackInfo?: Partial<GameAnimationPlaybackConfig>,
    ) => GameAnimation<GameEntityKeyframe, GameEntity>

    在实体上播放动画

    getAnimations: () => GameAnimation<GameEntityKeyframe, GameEntity>[]

    获取实体当前播放的所有动画

    nextClick: GameEventFuture<GameClickEvent>

    下一次玩家点击此实体时的未来事件

    nextDestroy: GameEventFuture<GameEntityEvent>

    下一次实体被销毁时的未来事件

    nextDie: GameEventFuture<GameDieEvent>

    下一次实体死亡时的未来事件

    nextEntityContact: GameEventFuture<GameEntityContactEvent>

    下一次实体接触另一个实体时的未来事件

    nextEntitySeparate: GameEventFuture<GameEntityContactEvent>

    下一次实体停止接触另一个实体时的未来事件

    nextFluidEnter: GameEventFuture<GameFluidContactEvent>

    下一次实体进入流体时的未来事件

    nextFluidLeave: GameEventFuture<GameFluidContactEvent>

    下一次实体离开流体时的未来事件

    nextInteract: GameEventFuture<GameInteractEvent>

    下一次实体与另一个实体互动时的未来事件

    nextTakeDamage: GameEventFuture<GameDamageEvent>

    下一次实体受到伤害时的未来事件

    nextVoxelContact: GameEventFuture<GameVoxelContactEvent>

    下一次实体接触方块时的未来事件

    nextVoxelSeparate: GameEventFuture<GameVoxelContactEvent>

    下一次实体停止接触方块时的未来事件

    onClick: GameEventChannel<GameClickEvent>

    当玩家点击此实体时调用

    chat

    say: (
        message: string,
        options?: Partial<{ duration: number; hideFloat: boolean }>,
    ) => void

    使实体说话

    destroy

    destroy: () => void

    销毁实体

    destroyed: boolean

    如果为 true，表示实体已被销毁

    onDestroy: GameEventChannel<GameEntityEvent>

    当实体被销毁时调用

    entityName

    customName: string

    实体名称

    nameColor: GameRGBColor

    实体名称的颜色

    nameRadius: number

    显示实体名称的半径范围

    showEntityName: boolean

    显示实体名称

    health

    enableDamage: boolean

    是否启用伤害

    hp: number

    当前生命值

    hurt: (amount: number, options?: Partial<GameHurtOptions>) => void

    对实体造成伤害

    maxHp: number

    最大生命值

    onDie: GameEventChannel<GameDieEvent>

    当实体死亡时调用

    onTakeDamage: GameEventChannel<GameDamageEvent>

    当实体受到伤害时调用

    showHealthBar: boolean

    是否显示生命条

    interact

    enableInteract: boolean

    启用交互

    interactColor: GameRGBColor

    交互提示文本的颜色

    interactHint: string

    交互实体的提示文本

    interactRadius: number

    交互的半径范围

    interactive

    onInteract: GameEventChannel<GameInteractEvent>

    当实体与另一个实体互动时调用

    mesh

    anchorOffset: GameVector3

    几何中心与锚点的偏移量

    lookAt: (
        targetPosition: GameVector3,
        facingDirection?: "X" | "Y" | "Z",
        up?: GameVector3,
    ) => void

    使实体朝向指定位置

    mesh: any

    实体网格的哈希值。如果设置为空字符串，则实体没有网格。 除非对象是玩家，否则如果设置了网格，则使用网格来计算对象的边界

    meshColor: GameRGBAColor

    网格颜色

    meshEmissive: number

    网格发光度

    meshInvisible: boolean

    使网格不可见

    meshMetalness: number

    网格金属度

    meshOffset: GameVector3

    网格偏移

    meshOrientation: GameQuaternion

    网格方向

    meshScale: GameVector3

    网格缩放

    meshShininess: number

    网格光泽度

    rotateLocal: (
        localPosition: GameVector3,
        axis: "X" | "Y" | "Z",
        rad: number,
    ) => void

    围绕模型自身坐标系下的某个点进行旋转

    Type declaration

      • (localPosition: GameVector3, axis: "X" | "Y" | "Z", rad: number): void

      • Parameters

        • localPosition: GameVector3

          一个包含x、y、z坐标的三维向量，表示待旋转的位置

        • axis: "X" | "Y" | "Z"

          一个字符串，指定旋转轴可以是'X'、'Y'或'Z'

        • rad: number

          旋转的角度，以弧度为单位

        Returns void

    scaleLocal: (localPosition: GameVector3, v: GameVector3) => void

    参照模型自身坐标系下的某个点进行缩放

    Type declaration

      • (localPosition: GameVector3, v: GameVector3): void

      • Parameters

        • localPosition: GameVector3

          本地坐标系中的位置向量，表示待缩放的点

        • v: GameVector3

          缩放向量，表示在x、y、z轴上的缩放因子

        Returns void

    motion

    motion: GameMotionController<GameEntity>

    运动控制器

    particle

    particleAcceleration: GameVector3

    粒子加速度/重力力矢量 单位是方块/(滴答^2)

    particleColor: GameRGBColor[]

    粒子颜色样条曲线。最多 5 个条目，粒子在其生命周期内沿这 5 个点插值颜色。 颜色是发光值，可以在 0 到 256 之间取任何值

    particleDamping: number

    粒子阻尼指数。 0 = 无阻尼 正值减慢粒子 负值加速粒子

    particleLifetime: number

    控制每个粒子的生命周期（以秒为单位）

    particleLifetimeSpread: number

    粒子生命周期的变化范围（以秒为单位）

    particleLimit: number

    该实体可以发射的最大粒子数

    particleNoise: number

    粒子噪声幅度。影响粒子运动

    particleNoiseFrequency: number

    粒子噪声频率。增加噪声偏置的运动速率

    particleRate: number

    粒子发射速率（每秒粒子数）

    particleRateSpread: number

    粒子发射的变化范围

    particleSize: number[]

    粒子大小样条曲线。最多 5 个条目，粒子在其生命周期内沿这 5 个点插值大小

    particleSizeSpread: number

    粒子大小分布

    particleTarget: GameEntity

    粒子目标实体

    particleTargetWeight: number

    粒子目标权重

    particleVelocity: GameVector3

    粒子速度偏置。单位是方块/滴答

    particleVelocitySpread: GameVector3

    粒子速度随机化范围。单位是方块/滴答

    physics

    bounds: GameVector3

    实体边界框在 x/y/z 轴上的半径

    collides: boolean

    如果为 false，物体不会发生碰撞

    contactForce: GameVector3

    应用于此对象的净接触力

    entityContacts: GameEntityContact[]

    返回所有活动的实体接触列表

    fixed: boolean

    如果为 true，物体不会移动

    fluidContacts: GameFluidContact[]

    返回所有活动的流体接触列表

    friction: number

    控制物体的粘性（0 = 滑，1 = 粘）

    gravity: boolean

    如果为 false，物体不会受到重力影响

    mass: number

    实体的质量

    onEntityContact: GameEventChannel<GameEntityContactEvent>

    当实体接触另一个实体时调用

    onEntitySeparate: GameEventChannel<GameEntityContactEvent>

    当实体停止接触另一个实体时调用

    onFluidEnter: GameEventChannel<GameFluidContactEvent>

    当实体进入流体时调用

    onFluidLeave: GameEventChannel<GameFluidContactEvent>

    当实体离开流体时调用

    onVoxelContact: GameEventChannel<GameVoxelContactEvent>

    当实体接触方块时调用

    onVoxelSeparate: GameEventChannel<GameVoxelContactEvent>

    当实体停止接触方块时调用

    position: GameVector3

    实体的位置

    restitution: number

    控制弹跳性（0 = 软，1 = 弹）

    velocity: GameVector3

    实体的速度

    voxelContacts: GameVoxelContact[]

    返回所有活动的方块接触列表

    player

    isPlayer: boolean

    如果为 true，则该实体是玩家

    已废弃。请直接使用 if (entity.player) 进行玩家实体存在性检查，这能让TypeScript自动推断出 GameEntity.player 在该代码块中是已定义的 GamePlayer 类型，从而提高类型安全性。

    player: GamePlayer

    如果实体是玩家，则此属性存在。 所有特定于玩家的状态和方法的引用

    selectors

    addTag: (tag: string) => void

    向实体添加新标签

    hasTag: (tag: string) => boolean

    测试实体是否具有某个标签

    id: string

    实体在编辑器中的种子名称

    removeTag: (tag: string) => void

    从实体中移除标签

    tags: () => string[]

    获取分配给实体的所有标签集合

    sound

    chatSound: GameSoundEffect

    当实体聊天时播放的声音

    dieSound: GameSoundEffect

    当实体死亡时播放的声音

    hurtSound: GameSoundEffect

    当实体受到伤害时播放的声音

    interactSound: GameSoundEffect

    当实体被交互时播放的声音

    sound: (spec: any) => Sound

    在实体位置播放音效

    Settings

    Member Visibility

    On This Page

    Other
    chat
    destroy
    entityName
    health
    interact
    interactive
    mesh
    motion
    particle
    physics
    player
    selectors
    sound