KaleidoscopePlugin Docs Help

Entity - 实体

实体类

Entity.getLocalPlayer()

  • 描述: 获取当前本地玩家。

  • 返回值: Entity

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); Helper.sendTip("Local Player: " + localPlayer);

Entity.getEntityName(Entity)

  • 描述: 获取实体的名称。

  • 参数: Entity

  • 返回值: 实体名称。 string

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); var name = Entity.getEntityName(localPlayer); Helper.sendTip("Local Player's Name: " + name);

Entity.getEntityLevel(entity)

  • 描述: 获取实体的Level指针。

  • 参数: Entity

  • 返回值: Level

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); var level = Entity.getEntityLevel(localPlayer); //注意 这个获取的并不是玩家的等级(1-255)而是Level指针

Entity.getEntityPos(entity)

  • 描述: 获取实体的坐标。

  • 参数: Entity

  • 返回值: 实体的坐标向量数组 Vec3

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); var pos = Entity.getEntityPos(localPlayer); var x = pos[0]; var y = pos[1]; var z = pos[2]; Helper.sendTip("Local Player's Pos: " + x + y + z);

Entity.getEntityMotion(entity)

  • 描述: 获取实体的运动状态向量。

  • 参数: Entity

  • 返回值: 向量数组 Vec3

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); var motion = Entity.getEntityMotion(localPlayer); var x = motion[0]; var y = motion[1]; var z = motion[2]; Helper.sendTip("Local Player's Motion: " + x + y + z);

Entity.getEntityAABB(entity)

  • 描述: 获取实体的 AABB (Axis-Aligned Bounding Box)。

  • 参数: Entity

  • 返回值: AABB数组 Vec6

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); var aabb = Entity.getEntityAABB(localPlayer); var form_x = aabb[0]; var form_y = aabb[1]; var form_z = aabb[2]; var to_x = aabb[3]; var to_y = aabb[4]; var to_z = aabb[5];

Entity.getEntityRuntimeId(entity)

  • 描述: 获取实体的运行时 ID。

  • 参数: Entity

  • 返回值: 实体的运行时 ID。 number

  • 示例代码:

var localPlayer = Entity.getLocalPlayer(); var runtimeId = Entity.getEntityRuntimeId(localPlayer); Helper.sendTip("Local Player's RuntimeId: " + runtimeId);

Entity.isInWater(entity)

  • 描述: 判断实体是否在水中。

  • 参数: Entity

  • 返回值: bool

  • 注意: 若实体在水中则为 true ,否则为 false

var localPlayer = Entity.getLocalPlayer(); var isInWater = Entity.isInWater(localPlayer); Helper.sendTip("Local Player IsInWater: " + isInWater);

Entity.getEntityType(entity)

  • 描述: 获取实体的类型。

  • 参数: Entity

  • 返回值: number

var localPlayer = Entity.getLocalPlayer(); var type = Entity.getEntityType(localPlayer); Helper.sendTip("Local Player's Type: " + type);

Entity.removeEntity(entity)

  • 描述: 移除指定实体。(使本地不可见)

  • 参数: Entity

var localPlayer = Entity.getLocalPlayer(); Entity.removeEntity(localPlayer); //这里虽然使用本地玩家来测试,但是最好不要使用本地玩家,不知道会出现什么问题,可能会闪退哦

Entity.isInVisible(entity)

  • 描述: 判断实体是否可见。

  • 参数: Entity

  • 返回值: bool

  • 注意: 若实体可见则为 true ,否则为 false

var localPlayer = Entity.getLocalPlayer(); var isInVisible = Entity.isInVisible(localPlayer); Helper.sendTip("Local Player IsInVisible: " + isInVisible);

Entity.swing(entity)

  • 描述: 实体挥手动作。

  • 参数: Entity

  • 注意: 似乎只对本地玩家生效。

var localPlayer = Entity.getLocalPlayer(); Entity.swing(localPlayer);

Entity.setEntityMotion(entity, x, y, z)

  • 描述: 设置实体的运动状态。

  • 参数:

    • Entity - 实体对象。

    • x - 运动的 X 轴分量。

    • y - 运动的 Y 轴分量。

    • z - 运动的 Z 轴分量。

var localPlayer = Entity.getLocalPlayer(); Entity.setEntityMotion(localPlayer,0,0,0);

Entity.isAlive(entity)

  • 描述: 判断实体是否活着。

  • 参数: Entity

  • 返回值: bool

  • 注意: 若实体存活则为 true ,否则为 false

var localPlayer = Entity.getLocalPlayer(); var isAlive = Entity.isAlive(localPlayer); Helper.sendTip("Local Player IsAlive: " + isAlive);

Entity.setBodyRot(entity, y)

  • 描述: 设置实体的身体旋转角度。

  • 参数:

    • Entity - 实体对象。

    • y - Y 轴的旋转角度。

var localPlayer = Entity.getLocalPlayer(); Entity.setBodyRot(localPlayer,180);

Entity.setHeadRot(entity, y)

  • 描述: 设置实体的头部旋转角度。

  • 参数:

    • Entity - 实体对象。

    • y - Y 轴的旋转角度。

var localPlayer = Entity.getLocalPlayer(); Entity.setHeadRot(localPlayer,180);

Entity.isOnGround(entity)

  • 描述: 判断实体是否在地面上。

  • 参数: Entity

  • 返回值: bool

  • 注意: 若实体在地面上则为 true ,否则为 false

var localPlayer = Entity.getLocalPlayer(); var isOnGround = Entity.isOnGround(localPlayer); Helper.sendTip("Local Player IsOnGround: " + isAlive);

Entity.setIsOnGround(entity, state)

  • 描述: 设置实体是否在地面上。

  • 参数:

    • Entity - 实体对象。

    • state - 布尔值,若为 true ,实体将被设置为在地面上。

var localPlayer = Entity.getLocalPlayer(); Entity.setIsOnGround(localPlayer,false);

Entity.isJumping(entity)

  • 描述: 判断实体是否正在跳跃。(可用于判断是否点击跳跃键)

  • 参数: Entity - 实体对象。

  • 返回值: bool

  • 注意: 若实体正在跳跃则为 true ,否则为 false

var localPlayer = Entity.getLocalPlayer(); var isJumping = Entity.isJumping(localPlayer); Helper.sendTip("Local Player IsJumping: " + isJumping);

Entity.isPlayer(entity)

  • 描述: 判断实体是否为玩家。

  • 参数: Entity - 实体对象。

  • 返回值: bool

  • 注意: 若是为 true ,否则为 false

var localPlayer = Entity.getLocalPlayer(); var isPlayer = Entity.isPlayer(localPlayer); Helper.sendTip("Local Player IsPlayer: " + isPlayer);

Entity.getPlayerList()

  • 描述: 获取目前世界的所有玩家。

  • 返回值: 玩家数组。 VectorN*

var playerList = Entity.getPlayerList(); //var firstPlayer = playerList[0]; Helper.sendTip("PlayerCount: " + playerList.length);

Entity.getEntityList()

  • 描述: 获取目前世界的所有实体。

  • 返回值: 实体数组。 VectorN*

var entityList = Entity.getEntityList(); //var firstEntity = entityList[0]; Helper.sendTip("EntityCount: " + entityList.length);
Last modified: 15 三月 2025