这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录前一修订版后一修订版 | 前一修订版 | ||
scripting:world:billboard [2023/08/09 12:47] – bibiboxs | scripting:world:billboard [2024/04/05 14:39] (当前版本) – bibiboxs | ||
---|---|---|---|
行 4: | 行 4: | ||
## Property | ## Property | ||
- | ### Billboard.ID | + | ### billboard.ID |
> 获取展示牌序列ID,每个实例ID是唯一的。 | > 获取展示牌序列ID,每个实例ID是唯一的。 | ||
行 11: | 行 11: | ||
```javascript | ```javascript | ||
- | Billboard.ID: int | + | billboard.ID: int |
``` | ``` | ||
- | ### Billboard.UUID | + | ### billboard.UUID |
- | > 获取展示牌UUID,这是由一串较长的字符串组成的全局唯一**文本ID**。 | + | > 获取展示牌UUID,这是由一串较长的字符串组成的全局唯一**文本ID**(实例化时自动赋值,非持久化数据)。 |
```javascript | ```javascript | ||
- | Billboard.UUID: string | + | billboard.UUID: string |
``` | ``` | ||
- | ### Billboard.Pos | + | ### billboard.Pos |
> 设置展示牌坐标。 | > 设置展示牌坐标。 | ||
```javascript | ```javascript | ||
- | Billboard.Pos = Vector(0, 0, 0); | + | billboard.Pos = Vector(0, 0, 0); |
``` | ``` | ||
+ | ### billboard.World | ||
- | ### Billboard.Type | + | > 设置展示牌实例世界ID(不同世界将不可视\不可交互)。 |
+ | |||
+ | ```javascript | ||
+ | billboard.World = 0; //int | ||
+ | ``` | ||
+ | |||
+ | |||
+ | ### billboard.Type | ||
> 获取展示牌实例类型,不同类型的展示牌有不同的作用和特定属性。 | > 获取展示牌实例类型,不同类型的展示牌有不同的作用和特定属性。 | ||
行 52: | 行 60: | ||
- | ### Billboard.Color | + | ### billboard.Color |
- | > 设置展示牌实例对象颜色,不同的`Type`对象有不同的默认值(例如`Sprite: | + | > 设置展示牌实例对象颜色,不同的`Type`对象有不同的默认值(例如`Sprite: |
> | > | ||
> *注意:这里所设置的颜色目标不一定是想象中的目标,比如`Bubble`设置的颜色其实是【气泡背景颜色】,如果想修改文本颜色请使用`Text`UBB颜色代码。* | > *注意:这里所设置的颜色目标不一定是想象中的目标,比如`Bubble`设置的颜色其实是【气泡背景颜色】,如果想修改文本颜色请使用`Text`UBB颜色代码。* | ||
```javascript | ```javascript | ||
- | Billboard.Color = Color(255, 255, 255); //Color | + | billboard.Color = Color(255, 255, 255, 255); //Color |
``` | ``` | ||
- | ### Billboard.Alpha | + | ### billboard.Alpha |
- | > 设置展示牌实例透明度,默认为`255`。 | + | > 设置展示牌实例整体透明度,默认为`255`。 |
```javascript | ```javascript | ||
- | Billboard.Alpha = 255; //int | + | billboard.Alpha = 255; //int |
``` | ``` | ||
- | ### Billboard.Scale | + | ### billboard.Scale |
> 设置展示牌实例尺寸缩放(比例),默认尺寸比例是`1.0`。 | > 设置展示牌实例尺寸缩放(比例),默认尺寸比例是`1.0`。 | ||
```javascript | ```javascript | ||
- | Billboard.Scale = 1.0; //float | + | billboard.Scale = 1.0; //float |
``` | ``` | ||
- | ### Billboard.Baffle | + | ### billboard.Baffle |
- | > 设置展示牌是否存在遮挡逻辑,默认为`false`,如果设置`true`将作为一个物体,可以被其他物体遮挡。 | + | > 设置展示牌是否存在遮挡逻辑,默认为`true`,如果设置`false`将不会被其他物体遮挡。 |
```javascript | ```javascript | ||
- | Billboard.Baffle = false; //bool | + | billboard.Baffle = true; //bool |
``` | ``` | ||
- | ### Billboard.Collision | + | ### billboard.Collision |
> 设置展示牌是否存在碰撞逻辑,默认为`false`,通常情况下不需要进行修改。 | > 设置展示牌是否存在碰撞逻辑,默认为`false`,通常情况下不需要进行修改。 | ||
```javascript | ```javascript | ||
- | Billboard.Collision = false; //bool | + | billboard.Collision = false; //bool |
``` | ``` | ||
- | ### Billboard.Target | + | ### billboard.Target |
> 设置展示牌跟随绑定对象,默认为`null`。 | > 设置展示牌跟随绑定对象,默认为`null`。 | ||
```javascript | ```javascript | ||
- | Billboard.Target = null; // | + | billboard.Target = null; // |
``` | ``` | ||
- | ### Billboard.Offset | + | ### billboard.Offset |
> 设置展示牌本地坐标偏移,默认为`Vector(0, | > 设置展示牌本地坐标偏移,默认为`Vector(0, | ||
行 121: | 行 129: | ||
```javascript | ```javascript | ||
- | Billboard.Offset = Vector(0, 0, 0); | + | billboard.Offset = Vector(0, 0, 0); |
``` | ``` | ||
- | ### Billboard.Sprite | + | ### billboard.Sprite |
> 设置展示牌显示图片(只在`Type: | > 设置展示牌显示图片(只在`Type: | ||
```javascript | ```javascript | ||
- | Billboard.Sprite = 0; // | + | billboard.Sprite = 0; // |
``` | ``` | ||
- | ### Billboard.Text | + | ### billboard.Text |
- | > 设置展示牌显示气泡文本(只在`Type: 1`模式生效)。 | + | > 设置展示牌显示气泡文本(只在可附带文本的组件生效,例如图片组件则是无效的)。 |
```javascript | ```javascript | ||
- | Billboard.Text = "Hello World!"; | + | billboard.Text = "Hello World!"; |
``` | ``` | ||
- | ### Billboard.ProgressType | + | ### billboard.ProgressType |
> 设置展示牌显示进度条样式(只在`Type: | > 设置展示牌显示进度条样式(只在`Type: | ||
```javascript | ```javascript | ||
- | Billboard.ProgressType = 0; //int | + | billboard.ProgressType = 0; //int |
``` | ``` | ||
行 163: | 行 171: | ||
- | ### Billboard.Progress | + | ### billboard.Progress |
> 设置展示牌显示进度条进度**百分比**(只在`Type: | > 设置展示牌显示进度条进度**百分比**(只在`Type: | ||
```javascript | ```javascript | ||
- | Billboard.Progress = 0.0; //float | + | billboard.Progress = 0.0; //float |
``` | ``` | ||
- | ### Billboard.MaxProgress | + | ### billboard.MaxProgress |
> 设置展示牌显示进度条最大进度(只在`Type: | > 设置展示牌显示进度条最大进度(只在`Type: | ||
```javascript | ```javascript | ||
- | Billboard.MaxProgress = 0.0; //float | + | billboard.MaxProgress = 0.0; //float |
+ | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### billboard.IgnoreMatch | ||
+ | |||
+ | > 设置展示牌**忽略匹配表达式**。 | ||
+ | > | ||
+ | > 表达式内包含的`PlayerID`将被屏蔽(不可见),这可能用于【玩家头顶名称】对玩家自身不可见等情况。 | ||
+ | |||
+ | ```javascript | ||
+ | billboard.IgnoreMatch = ""; | ||
+ | ``` | ||
+ | |||
+ | ```javascript | ||
+ | billboard.IgnoreMatch = " | ||
+ | billboard.IgnoreMatch = " | ||
``` | ``` | ||
行 190: | 行 215: | ||
```javascript | ```javascript | ||
- | function Billboard.Create( type: int, pos: Vector ): Billboard | + | function Billboard.Create( type: int, pos: Vector |
``` | ``` | ||
行 199: | 行 224: | ||
newBB.Sprite = 0; // | newBB.Sprite = 0; // | ||
``` | ``` | ||
+ | |||
+ | |||
+ | |||
+ | ### Billboard.CreateTips() | ||
+ | |||
+ | > 生成一个**小文本气泡**实例(类似**【血量-10】**的气泡样式),这是一个本地静态实例,因此没有返回值。 | ||
+ | |||
+ | ```javascript | ||
+ | function Billboard.CreateTips( text: string, pos: Vector, time: float = 3, scale: float = 1, hasBG: bool = true, hasRotate: bool = true ) | ||
+ | ``` | ||
+ | |||
+ | - **text:**文本内容 | ||
+ | - **pos:**世界坐标 | ||
+ | - **time:**显示时间(自动销毁) | ||
+ | - **scale:**尺寸缩放(相对于屏幕尺寸,而非距离远近) | ||
+ | - **hasBG:**是否显示黑色背景(默认开启) | ||
+ | - **hasRotate:**是否随机角度(默认开启) | ||
+ | |||
+ | |||
+ | |||
+ | ### Billboard.CreateSpriteBubble() | ||
+ | |||
+ | > 生成一个**图片气泡**实例(可实现表情图片等),这是一个本地静态实例,因此没有返回值。 | ||
+ | |||
+ | ```javascript | ||
+ | function Billboard.CreateSpriteBubble( texture: int, pos: Vector, time: float = 3, scale: float = 1, hasBG: bool = true, hasRotate: bool = true ) | ||
+ | ``` | ||
+ | |||
+ | - **text:**文本内容 | ||
+ | - **pos:**世界坐标 | ||
+ | - **time:**显示时间(自动销毁) | ||
+ | - **scale:**尺寸缩放(相对于屏幕尺寸,而非距离远近) | ||
+ | - **hasBG:**是否显示黑色背景(默认开启) | ||
+ | - **hasRotate:**是否随机角度(默认开启) | ||
行 222: | 行 281: | ||
- | ### Billboard.FindByIndex() | + | ### Billboard.GetCount() |
- | > 寻找一个展示牌实例(通过索引),不存在则返回`null`。 | + | > 获取当前所有存在展示牌数量(不包括静态对象)。 |
```javascript | ```javascript | ||
- | function Billboard.FindByIndex( index: int ): Billboard | + | function Billboard.GetCount(): int |
``` | ``` | ||
- | ### Billboard.GetCount() | + | ### Billboard.Get() |
- | > 获取当前所有存在展示牌数量(不包括静态对象)。 | + | > 获取当前存在的指定索引展示牌实例,通常搭配`GetCount()`遍历使用。 |
```javascript | ```javascript | ||
- | function Billboard.GetCount(): int | + | function Billboard.Get( index: int ): Billboard |
``` | ``` | ||
行 244: | 行 303: | ||
## Function | ## Function | ||
- | ### Billboard.Remove() | + | ### billboard.Remove() |
> 销毁当前展示牌实例。 | > 销毁当前展示牌实例。 | ||
```javascript | ```javascript | ||
- | function | + | function |
``` | ``` | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||