meta data for this page
  •  

📚 差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

后一修订版		前一修订版
scripting:client:entity [2023/11/07 12:07] – 创建 bibiboxsscripting:client:entity [2025/07/12 04:18] (当前版本) – bibiboxs
行 13: 行 13:
 | [Checkpoint](scripting/client/checkpoint) | 检查点类   | | [Checkpoint](scripting/client/checkpoint) | 检查点类   |
 | [Model](scripting/client/model)           | 模型对象类 | | [Model](scripting/client/model)           | 模型对象类 |
 +
 +
 +
 +## Property
 +
 +### entity.Is...
 +
 +> 判断当前实例是否为指定`Entity`类型。
 +>
 +> *此功能可用来判断当前实例是何种类型（角色、载具等……）。*
 +
 +```javascript
 +function entity.Is...; //bool
 +function entity.IsCharacter; //bool
 +function entity.IsVehicle; //bool
 +function entity.IsPickup; //bool
 +function entity.IsCheckpoint; //bool
 +function entity.IsModel; //bool
 +```
 +
 +
 +
 +### entity.As...
 +
 +> 尝试转换当前实例为指定`Entity`类型。
 +
 +```javascript
 +function entity.As...; //...
 +function entity.AsCharacter; //Character
 +function entity.AsVehicle; //Vehicle
 +function entity.AsPickup; //Pickup
 +function entity.AsCheckpoint; //Checkpoint
 +function entity.AsModel; //Model
 +```
 +
 +
 +
 +### entity.Data
 +
 +> 内置的自定义类型属性（建议使用基础类型），可供开发者自行使用，需要自行做好类型Type和生命周期处理。
 +
 +```javascript
 +entity.Data = null; //any
 +```
 +
 +
 +
 +### entity.Outline
 +
 +> 设置当前实体对象描边效果开关。
 +
 +```javascript
 +entity.Outline = false; //bool
 +```
 +
 +
 +
 +### entity.OutlineColor
 +
 +> 设置当前实体对象的描边效果颜色代码。
 +>
 +> 默认支持**3个全局共享颜色（索引）**，可使用`Client.Core.SetOutlineColor()`全局修改。
 +
 +```javascript
 +entity.OutlineColor = 0; //int
 +```
 +
 +
  
 ## Function ## Function
行 57: 行 125:
 myCharacter.GetInstance(); //返回：Character类，举一反三 myCharacter.GetInstance(); //返回：Character类，举一反三
 ``` ```
 +
 +
 +
 +### entity.GetVisualRange()
 +
 +> 获取实体相对于**本地玩家**的可见程度（距离流）。
 +>
 +> 此方法允许提交一个`true`参数，可用于立即刷新结果，通常可以忽略。
 +
 +```javascript
 +function entity.GetVisualRange( update: bool = false ): int
 +```
 +
 +| Index | 说明                             |
 +| ----- | -------------------------------- |
 +| -1    | 不可见（停止渲染和处理复杂计算） |
 +| 0     | 可见范围内（完全渲染及计算）     |
 +| 1     | 可见范围内，但距离较远           |
 +
 +
 +
 +### entity.Shake()
 +
 +> 执行实体对象的摇动动画效果（不会叠加），*此方法是服务端同名方法的本地映射。*
 +>
 +> **注意：此方法会在执行完毕后复位，因此应该仅用于静态的对象，而非移动中的对象（例如：砍树等）。**
 +
 +```javascript
 +function entity.Shake( type: int, duration: float = 0.5, strength: float = 0.1, vibrato: float = 10, randomness: int = 90 )
 +```
 +
 +- `type`：0=位置 1=旋转 2=缩放 3=组合 
 +- `duration`：持续时间（秒）
 +- `strength`：强度
 +- `vibrato`：频率
 +- `randomness`：随机度（默认`0~180`）
 +
 +
 +
 +### entity.StopShake()
 +
 +> 停止执行实体对象的摇动动画效果。
 +
 +```javascript
 +function entity.StopShake()
 +```
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
 </markdown> </markdown>