💡 光照

Light 代表一个光照源。

---

💂Authority

This class can be spawned on both 🟧 Client and 🟦 Server side.

🔁Network Authority Distribution

This class can't be Network Authority distributed.

👪Inheritance

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

🧑‍💻API Source

This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!

---

🎒 示例

local my_light = Light(
    Vector(-152, 245, 115),
    Rotator(0, 90, 90), -- Relevant only for Rect and Spot light types
    Color(1, 0, 0), -- Red Tint
    LightType.Point, -- Point Light type
    100, -- Intensity
    250, -- Attenuation Radius
    44, -- Cone Angle (Relevant only for Spot light type)
    0, -- Inner Cone Angle Percent (Relevant only for Spot light type)
    5000, -- Max Draw Distance (Good for performance - 0 for infinite)
    true, -- Whether to use physically based inverse squared distance falloff, where Attenuation Radius is only clamping the light's contribution. (Spot and Point types only)
    true, -- Cast Shadows?
    true -- Enabled?
)

🛠 构造函数

Default Constructor

No description provided

local my_light = Light(location, rotation?, color?, light_type?, intensity?, attenuation_radius?, cone_angle?, inner_cone_angle_percent?, max_draw_distance?, use_inverse_squared_falloff?, cast_shadows?, visible?, source_radius?, defer_spawn?)

Parameters

Type	Name	Default	Description
Vector	location	Required parameter	No description provided
Rotator	rotation	Rotator(0, 0, 0)	仅 Rect 和 Spot 光照类型有效
Color	color	Color(1, 1, 1)	No description provided
LightType	light_type	LightType.Point	No description provided
float	intensity	30	No description provided
float	attenuation_radius	250	No description provided
float	cone_angle	44	仅对 Spot 光照类型有效
float	inner_cone_angle_percent	0	内锥角百分比（仅对 Spot 光照类型有效）(0-1)
float	max_draw_distance	10000	最大绘制距离（有利于性能）- 0 表示无限远
boolean	use_inverse_squared_falloff	true	是否使用基于物理的平方反比距离衰减，此时衰减半径仅对光照的贡献进行剪裁。（仅限 Spot 和 Point 光源类型）
boolean	cast_shadows	true	No description provided
boolean	visible	true	No description provided
float	source_radius	2	光源形状的半径。（仅限 Spot 和 Point 光源类型）
boolean	defer_spawn	false	传入 true 以避免立即将该实体发送给客户端，从而在你想要通过设置多个配置来调整它时提高性能。最后必须调用 FinishSpawn()

提示

nanos world provides 3 types of lights: Spot, Point and Rect. All lights are Dynamic and because of that, very expensive! Keep that in mind before spawning 1000 lights 😉.

🗿 静态函数

Inherited Entity Static Functions

Light 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

Light 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	完成生成过程，如果实体是通过 defer_spawn 生成的，则将实体发送给客户端
	table of string	GetAllValuesKeys	获取所有值键的列表
	table	GetClass	获取该实体的类
	integer	GetID	获取该实体的全网通用网络 ID（在客户端和服务器上相同）
	any	GetValue	获取此实体上存储在给定键处的 值
	boolean	HasAuthority	获取本地上下文是否对此实体拥有主控（如果由客户端生成则为 true，由服务器生成则为 false）
	boolean	IsA	递归检查此实体是否继承自某个类
	boolean	IsBeingDestroyed	如果该实体正在被销毁，则返回 true
	boolean	IsValid	如果该实体有效（即未被销毁且指向一个有效的实体），则返回 true
		SetValue	在此实体中设置一个值
	function	Subscribe	在这个特定实体上订阅一个事件
	function	SubscribeRemote	在这个特定实体上订阅一个从服务器调用的自定义远程事件
		Unsubscribe	退订此包内该实体中此 事件 的所有回调，或者仅取消传入的特定回调

Inherited Actor Functions

Light 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	Returns the angular velocity of this 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	Returns the mass of this 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	Sets this Actor's distance optimization multiplier
		SetForce	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
		SetGravityEnabled	Sets whether gravity is enabled on this Actor
		SetHighlightEnabled	Sets whether the highlight is enabled on this Actor, and which highlight index to use
		SetLifeSpan	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
		SetLocation	Sets this Actor's location in the game world
		SetNetworkAuthority	Sets the Player to have network authority over this Actor
		SetNetworkAuthorityAutoDistributed	Sets if this Actor will auto distribute the network authority between players
		SetOutlineEnabled	Sets whether the outline is enabled on this Actor, and which outline index to use
		SetRelativeLocation	Sets this Actor's relative location in local space (only if this actor is attached)
		SetRelativeRotation	Sets this Actor's relative rotation in local space (only if this actor is attached)
		SetRenderCullDistance	Sets this Actor's render cull distance
		SetRotation	Sets this Actor's rotation in the game world
		SetScale	Sets this Actor's scale
		SetVisibility	Sets whether the actor is visible or not
		TranslateTo	Smoothly moves this actor to a location over a certain time
	boolean	WasRecentlyRendered	Gets if this Actor was recently rendered on screen

	Returns	Name	Description
	float	GetAttenuationRadius	No description provided
	boolean	GetCastShadows	No description provided
	Color	GetColor	No description provided
	float	GetIntensity	No description provided
		SetAttenuationRadius	No description provided
		SetCastShadows	No description provided
		SetColor	设置光照颜色
		SetIntensity	No description provided
		SetTextureLightProfile	设置光照的纹理轮廓

---

GetAttenuationRadius

local attenuation_radius = my_light:GetAttenuationRadius()

Returns

Type	Description
float	attenuation_radius

See also SetAttenuationRadius.

---

GetCastShadows

local is_shadows_enabled = my_light:GetCastShadows()

Returns

Type	Description
boolean	is_shadows_enabled

See also SetCastShadows.

---

GetColor

local color = my_light:GetColor()

Returns

Type	Description
Color	color

See also SetColor.

---

GetIntensity

local intensity = my_light:GetIntensity()

Returns

Type	Description
float	intensity

See also SetIntensity.

---

SetAttenuationRadius

my_light:SetAttenuationRadius(attenuation_radius)

Parameters

Type	Parameter	Default	Description
float	attenuation_radius	Required parameter	No description provided

See also GetAttenuationRadius.

---

SetCastShadows

my_light:SetCastShadows(is_shadows_enabled)

Parameters

Type	Parameter	Default	Description
boolean	is_shadows_enabled	Required parameter	No description provided

See also GetCastShadows.

---

SetColor

设置光照颜色

my_light:SetColor(color)

Parameters

Type	Parameter	Default	Description
Color	color	Required parameter	光照颜色

See also GetColor.

---

SetIntensity

my_light:SetIntensity(intensity)

Parameters

Type	Parameter	Default	Description
float	intensity	Required parameter	No description provided

See also GetIntensity.

---

SetTextureLightProfile

设置光照的纹理轮廓

my_light:SetTextureLightProfile(light_profile)

Parameters

Type	Parameter	Default	Description
LightProfile	light_profile	Required parameter	要使用的光照轮廓

See also 💡 Light Profiles.

🚀 事件

Inherited Entity Events

Light 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

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

	Name	Description
	DimensionChange	当 Actor 改变其维度时触发
	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.

💡 Light Profiles

Light Profiles are texture files which describes a light's distribution from a light source using real world measured data.

提示

Please check Unreal Engine Light Profile documentation for more information about Light Profiles!

nanos world provides 50 Light Profiles included in the base game which you can use to enhance your Lights. You can set them using :SetTextureLightProfile() with the enum LightProfile.