版本：bleeding-edge 🩸

🪧 广告牌

Billboard 是一个 2D 材质，它在渲染时会始终面向相机。

👪Inheritance

This class shares methods and events from Base Entity, Base Actor, Base Paintable.

🎒 示例

Client/Index.lua
local my_billboard = Billboard(
    Vector(200, 200, 200), -- location
    "nanos-world::M_Default_Masked_Lit", -- 材质
    Vector2D(32, 32), -- size
    true
)

my_billboard:SetMaterialTextureParameter("Texture", "package://my_package/Client/image.jpg")

🛠 构造函数

Default Constructor

No description provided

local my_billboard = Billboard(location, material_asset, size?, size_in_screen_space?)

Parameters

Type	Name	Default	Description
Vector	`location`	Required parameter	No description provided
Material Reference	`material_asset`	Required parameter	No description provided
Vector2D	`size`	`Vector2D(32, 32)`	No description provided
boolean	`size_in_screen_space`	`false`	尺寸是基于屏幕空间还是世界空间

🗿 静态函数

Inherited Entity Static Functions

Billboard inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

Returns	Name	Description
table of Base Entity	`GetAll`	返回一个包含调用此方法的类中所有实体的表
Base Entity	`GetByIndex`	返回该类中指定索引处的特定实体
integer	`GetCount`	返回该类当前存在的实体数量
table of table	`GetInheritedClasses`	获取使用继承系统创建的、直接继承自该类的所有子类列表
iterator	`GetPairs`	返回一个包含该类所有实体的迭代器，用于 `pairs()` 循环
table or nil	`GetParentClass`	如果该类是使用继承系统创建的，则获取其父类
table	`Inherit`	使用继承系统继承此类
boolean	`IsChildOf`	如果该类是使用继承系统创建的，检查此类是否为另一个类的子类
function	`Subscribe`	为该类的所有实体订阅一个事件
function	`SubscribeRemote`	订阅从服务器调用的自定义远程事件
	`Unsubscribe`	退订此包内该类中此事件的所有回调，或者仅取消传入的特定回调

This class doesn't have own static functions.

🦠 函数

Inherited Entity Functions

Billboard inherits from Base Entity Class, sharing it's methods and functions:
Base Entityscripting-reference/classes/base-classes/entity

Returns	Name	Description
	`BroadcastRemoteEvent`	直接在此实体上向所有玩家调用自定义远程事件
	`BroadcastRemoteInRadiusEvent`	直接针对此实体调用自定义远程事件，并将该事件传递给半径范围内的所有玩家
	`CallRemoteEvent`	直接在此实体上向特定玩家调用自定义远程事件
	`CallRemoteEvent`	直接在此实体上调用自定义远程事件
	`CallRemotePlayersEvent`	直接在此实体上调用自定义远程事件，并将事件传递给玩家列表
	`Destroy`	销毁该实体
	`FinishSpawn`	如果此实体是以延迟 `spawn_mode` 生成的，则完成生成过程并将该实体发送至客户端
table of string	`GetAllValuesKeys`	获取所有值键的列表
table	`GetClass`	获取该实体的类
integer	`GetID`	获取该实体的全网通用网络 ID（在客户端和服务器上相同）
any	`GetValue`	获取此实体上存储在给定键处的值
boolean	`HasAuthority`	获取本地上下文是否对此实体拥有主控（如果由客户端生成则为 true，由服务器生成则为 false）
boolean	`IsA`	递归检查此实体是否继承自某个类
boolean	`IsBeingDestroyed`	如果该实体正在被销毁，则返回 true
boolean	`IsSpawned`	获取此实体是否已完成生成
boolean	`IsValid`	如果该实体有效（即未被销毁且指向一个有效的实体），则返回 true
	`SetSpawnMode`	从继承类的构造函数中覆盖此实体完成生成的时间点
	`SetValue`	在此实体中设置一个值
function	`Subscribe`	在这个特定实体上订阅一个事件
function	`SubscribeRemote`	在这个特定实体上订阅一个从服务器调用的自定义远程事件
	`Unsubscribe`	退订此包内该实体中此事件的所有回调，或者仅取消传入的特定回调

Inherited Actor Functions

Billboard inherits from Base Actor Class, sharing it's methods and functions:
Base Actorscripting-reference/classes/base-classes/actor

Returns	Name	Description
	`AddActorTag`	向该 Actor 添加一个虚幻 Actor 标签
	`AddAngularImpulse`	向该 Actor 添加角冲量。适用于单次瞬间爆发
	`AddImpulse`	向该 Actor 添加冲量。适用于单次瞬间爆发
boolean	`AttachTo`	将该 Actor 附加到任何其他 Actor 上，可选择附加在特定骨骼处
	`Detach`	将该 Actor 从其附加的 Actor 上分离
table of string	`GetActorTags`	获取该 Actor 上的所有虚幻 Actor 标签
Vector	`GetAngularForce`	获取该 Actor 的角外力（由 `SetAngularForce()` 设置）
float	`GetAngularVelocity`	返回此 Actor 的角速度
table of Base Actor	`GetAttachedEntities`	获取附加到该 Actor 的所有 Actor
Base Actor or nil	`GetAttachedTo`	获取该 Actor 所附加到的父级 Actor
table	`GetBounds`	获取该 Actor 的边界范围
CollisionType	`GetCollision`	获取该 Actor 的碰撞类型
integer	`GetDimension`	获取该 Actor 的维度
float	`GetDistanceFromCamera`	获取该 Actor 距离相机的距离
Vector	`GetForce`	获取该 Actor 的持续外力（由 `SetForce()` 设置）
Vector	`GetLocation`	获取该 Actor 在游戏世界中的位置
float	`GetMass`	返回此 Actor 的质量
Player or nil	`GetNetworkAuthority`	获取该 Actor 的网络主控玩家
Vector	`GetRelativeLocation`	如果该 Actor 已附加，获取其相对位置
Rotator	`GetRelativeRotation`	如果该 Actor 已附加，获取其相对旋转
Rotator	`GetRotation`	获取该 Actor 在游戏世界中的角度值
Vector	`GetScale`	获取该 Actor 的缩放比例
float	`GetScreenPercentage`	获取该 Actor 在屏幕中所占尺寸的百分比
table	`GetSocketTransform`	在给定骨骼或插槽名称的情况下，获取世界空间中的插槽变换
Vector	`GetVelocity`	获取该 Actor 当前的速度
boolean	`HasNetworkAuthority`	如果本地玩家当前是该 Actor 的网络主控（Network Authority），则返回 true
boolean	`IsGravityEnabled`	如果该 Actor 启用了重力，则返回 true
boolean	`IsInWater`	如果该 Actor 处于水中，则返回 true
boolean	`IsNetworkDistributed`	如果该 Actor 当前处于网络分配状态，则返回 true
boolean	`IsVisible`	如果该 Actor 可见，则返回 true
	`RemoveActorTag`	从该 Actor 中移除一个虚幻 Actor 标签
	`RotateTo`	在一定时间内平滑旋转该 Actor 到指定角度
	`SetAngularForce`	向该 Actor 添加一个永久的角外力，设为 Vector(0, 0, 0) 可以取消
	`SetCastShadow`	设置该 Actor 是否投射阴影
	`SetCollision`	设置该 Actor 的碰撞类型
	`SetDimension`	设置该 Actor 的维度
	`SetDistanceOptimizationMultiplier`	设置此 Actor 的距离优化系数
	`SetForce`	向该 Actor 添加一个永久的外力，设为 Vector(0, 0, 0) 可以取消
	`SetGravityEnabled`	设置该 Actor 是否启用重力
	`SetHighlightEnabled`	设置该 Actor 是否启用高亮显示，以及使用哪个高亮索引值
	`SetLifeSpan`	设置该 Actor 被销毁前的生存时间（秒）。经过这段时间后，Actor 将被自动销毁。
	`SetLocation`	设置该 Actor 在游戏世界中的位置
	`SetNetworkAuthority`	设置某个玩家拥有此 Actor 的网络主控
	`SetNetworkAuthorityAutoDistributed`	设置该 Actor 是否在玩家之间自动分配网络主控
	`SetOutlineEnabled`	设置该 Actor 是否启用描边，以及使用哪个描边索引值
	`SetRelativeLocation`	在本地空间中设置该 Actor 的相对位置（仅在此 Actor 已附加时生效）
	`SetRelativeRotation`	在本地空间中设置该 Actor 的相对旋转（仅在此 Actor 已附加时生效）
	`SetRenderCullDistance`	设置该 Actor 的渲染剔除距离
	`SetRotation`	设置该 Actor 在游戏世界中的旋转
	`SetScale`	设置该 Actor 的缩放比例
	`SetVisibility`	设置该 Actor 是否可见
	`TranslateTo`	在一定时间内平滑地将该 Actor 移动到某个位置
boolean	`WasRecentlyRendered`	获取该 Actor 最近是否在屏幕上被渲染过

Inherited Paintable Functions

Billboard inherits from Base Paintable Class, sharing it's methods and functions:
Base Paintablescripting-reference/classes/base-classes/paintable

Returns	Name	Description
Color	`GetMaterialColorParameter`	从该 Actor 的材质中获取 Color 参数
float	`GetMaterialScalarParameter`	从该 Actor 的材质中获取 Scalar 参数
string	`GetMaterialTextureParameter`	从该 Actor 的材质中获取 Texture 参数
Vector	`GetMaterialVectorParameter`	从该 Actor 的材质中获取 Vector 参数
	`ResetMaterial`	将指定索引处的材质重置为原始材质
	`SetMaterial`	设置该 Actor 指定索引处的材质
	`SetMaterialColorParameter`	设置该 Actor 材质中的 Color 参数
	`SetMaterialFromCanvas`	将该 Actor 指定索引处的材质设为 Canvas 对象
	`SetMaterialFromSceneCapture`	将该 Actor 指定索引处的材质设为 SceneCapture 对象
	`SetMaterialFromWebUI`	将该 Actor 指定索引处的材质设为 WebUI 对象
	`SetMaterialScalarParameter`	设置该 Actor 材质中的 Scalar 参数
	`SetMaterialTextureParameter`	将该 Actor 材质中的纹理参数设为一张图像
	`SetMaterialVectorParameter`	设置该 Actor 材质中的 Vector 参数
	`SetPhysicalMaterial`	使用新的物理材质覆盖该 Actor 的物理材质

This class doesn't have own functions.

🚀 事件

Inherited Entity Events

Billboard inherits from Base Entity Class, sharing it's events:
Base Entityscripting-reference/classes/base-classes/entity

	Name	Description
	`ClassRegister`	当使用继承系统注册一个新类时触发
	`Destroy`	当实体被销毁时触发
	`Spawn`	当实体被生成/创建时触发
	`ValueChange`	当实体通过 `:SetValue()` 改变了值时触发

Inherited Actor Events

Billboard inherits from Base Actor Class, sharing it's events:
Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	`DimensionChange`	当 Actor 改变其维度时触发
	`EnterWater`	Triggered when an Actor enters a water body
	`LeaveWater`	Triggered when an Actor leaves a water body
	`NetworkAuthorityChange`	Triggered when an Actor changes its network authority Player
	`NetworkAuthorityChange`	Triggered when the local Player gets/loses network authority over this actor

This class doesn't have own events.

🎒 示例​

🛠 构造函数​

Default Constructor​