Passer au contenu principal
Version: latest - a1.7.0 ⚖️

💡 Light

Une entité Light représente une source d'éclairage.

info

🟦🟧 Authority: This class can be spawned on both Client and Server (if you spawn it on client, it won't be synchronized with other players).

Inheritance: This class inherits from Actor.

Nanos World met à disposition 3 types de lumières : Spot, Point et Rect. Toutes les entités Light sont dynamiques, et donc très coûteuses! Gardez cela à l'esprit avant de faire apparaître 1000 lumières 😉.

Utilisation

local my_light = Light(
Vector(-152, 245, 115),
Rotator(0, 90, 90), -- Pertinent uniquement pour les types d'éclairage Rect et Spot
Color(1, 0, 0), -- Teinte rouge
LightType.Point, -- Type de lumière "Point"
100, -- Intensité
250, -- Rayon d'atténuation
44, -- Angle du cône (ne concerne que le type de lumière Spot)
0, -- Angle du cône intérieur en pourcentage (ne concerne que le type de lumière Spot)
5000, -- Distance maximale d'affichage (bon pour la performance - 0 pour une distance infinie)
true, -- Utilisation ou non de l'affaiblissement de la distance au carré inverse basé sur la physique, où le rayon d'atténuation limite uniquement la contribution de la lumière. (Spot and Point types only)
true, -- Projeter des ombres ?
true -- Activé?
)

Constructor Parameters

TypeNomDefaultDescription
VectorlocationVector(0, 0, 0)
RotatorrotationRotator(0, 0, 0)Pertinent uniquement pour les types d'éclairage Rect et Spot
ColorcolorColor(1, 1, 1)
LightTypelight_typeLightType.Point
numberintensity30
numberattenuation_radius250
numbercone_angle44Pertinent uniquement pour le type d'éclairage Spot
numberinner_cone_angle_percent0Pourcentage d'angle du cône intérieur (pertinent uniquement pour le type de lumière Spot) (0-1)
numbermax_daw_distance5000Distance maximale d'affichage (bon pour la performance - 0 pour une distance infinie)
booleanuse_inverse_squared_fallofftrueUtilisation ou non de l'affaiblissement de la distance au carré inverse basé sur la physique, où le rayon d'atténuation limite uniquement la contribution de la lumière. (types de lumières Spot et Point uniquement)
booleancast_shadowstrue
booleanvisibletrue

Functions

Inherited Actor Functions
ReturnsNameDescription
AddImpulseApplies a Force in world space to this Actor
AttachToAttaches this Actor to another Actor
DestroyDestroys this Actor
DetachDetaches this Actor if attached
SetCollisionSets this Actor's collision type
SetForceAdds a permanent force to this Actor
SetGravityEnabledSets whether gravity is enabled on this Actor
SetVisibilitySets the Actor visibility
SetHighlightEnabledSets whether the highlight is enabled on this Actor, and which highlight index to use
SetOutlineEnabledSets whether the outline is enabled on this Actor, and which outline index to use
SetLifeSpanSets the time (in seconds) before this Actor is destroyed
SetLocationSets this Actor's location in the game world
SetNetworkAuthoritySets the Player this Actor will have its physics calculated on Network Authority
SetRelativeLocationSets this Actor's relative location in local space
SetRelativeRotationSets this Actor's relative rotation in local space
SetRotationSets this Actor's rotation in the game world
SetScaleSets this Actor's scale
SetValueSets a value in this Actor, which can be accessed by any package
TranslateToSmoothly moves this Actor to the specified location
RotateToSmoothly rotates this Actor to the specified angle
booleanHasNetworkAuthorityGets if the LocalPlayer is currently the Network Authority of this Actor
booleanHasAuthorityGets if this Actor was spawned by the client side
booleanIsBeingDestroyedGets if this Actor is being destroyed
booleanIsGravityEnabledGets whether gravity is enabled on this Actor
booleanIsVisibleGets whether this actor is Visible or not
booleanIsInWaterGets if this Actor is in water
booleanIsNetworkDistributedGets if this Actor is currently Network Distributed
booleanIsValidReturns if this Actor is valid (i.e. not destroyed)
tableGetAttachedEntitiesGets all Actors attached to this Actor
anyGetAttachedToGets the Actor this Actor is attached to
tableGetBoundsGets this Actor's bounds
numberGetCollisionGets this Actor's collision type
numberGetIDGets the universal network ID of this Actor
VectorGetLocationGets this Actor's location in the game world
RotatorGetRotationGets this Actor's angle in the game world
VectorGetForceGets this Actor's scale
VectorGetScaleGets this Actor's scale
stringGetTypeGets the type of this Actor
anyGetValueGets a value stored on this Actor at the given key
VectorGetVelocityReturns this Actor's current velocity
stringAddActorTagAdds an Unreal Actor Tag to this Actor
stringRemoveActorTag`Remove an Unreal Actor Tag from this Actor
tableGetActorTagsGets all Unreal Actor Tags from this Actor
functionSubscribeSubscribes to an Event
UnsubscribeUnsubscribes from an Event
Valeur retournéeNomDescription
SetColorDéfinit la couleur de la lumière
SetTextureLightProfileDéfinit le profil de texture de la lumière
SetEnabledActive/Désactive la lumière
SetCastShadowsActive/Désactive les ombres
SetIntensityDéfinit l'intensité
SetAttenuationRadiusDéfinit le rayon d'atténuation
booleanIsEnabled
booleanGetCastShadows
numberGetIntensity
numberGetAttenuationRadius
ColorGetColor

SetColor

Définit la couleur de la lumière

my_light:SetColor(couleur)
TypeParameterDefault ValueDescription
ColorcolorLa couleur de la lumière

SetTextureLightProfile

Définit le profil de texture de la lumière

my_light:SetTextureLightProfile(light_profile)
TypeParameterDefault ValueDescription
LightProfilelight_profileLe profil de lumière à utiliser

SetEnabled

my_light:SetEnabled(is_enabled)
TypeParameterDefault ValueDescription
numberis_enabled

SetCastShadows

my_light:SetCastShadows(is_shadows_enabled)
TypeParameterDefault ValueDescription
numberis_shadows_enabled

SetIntensity

my_light:SetIntensity(intensity)
TypeParameterDefault ValueDescription
numberintensity

SetAttenuationRadius

my_light:SetAttenuationRadius(attenuation_radius)
TypeParameterDefault ValueDescription
numberattenuation_radius

Events

Inherited Actor Events
NameDescription
DestroyTriggered when an Actor is destroyed
SpawnTriggered when an Actor is spawned/created
ValueChangeTriggered when an Actor has a value changed with :SetValue()

Profils de Lumière

Les profils lumineux sont des fichiers de textures qui décrivent la distribution d'une lumière à partir d'une source lumineuse en utilisant des données mesurées dans le monde réel.

tip

Veuillez consulter la documentation Unreal Engine Light Profile pour plus d'informations sur les profils de lumière!

Nanos World fournit 50 profils de lumière inclus dans le jeu de base que vous pouvez utiliser pour améliorer vos entités Light. Vous pouvez les définir en utilisant :SetTextureLightProfile() avec l'enum LightProfile.