Protected Member Functions
void	~ScriptedLightBase ()
override void	EOnInit (IEntity other, int extra)
override bool	IsScriptedLight ()
void	ScriptedLightBase ()
	Constructor. Everything here is executed before the constructor of all children.
void	UpdateMode ()

Protected Attributes
vector	m_DancingShadowsLocalPos
ref Timer	m_DeleteTimer
int	m_HiddenSelectionID
bool	m_IsDebugEnabled = false
ref LightDimming	m_LightDimming
vector	m_LocalOri
vector	m_LocalPos
Object	m_Parent

Static Protected Attributes
static ref set< ScriptedLightBase >	m_NightTimeOnlyLights = new set<ScriptedLightBase>()

Private Member Functions
void	AddLifetime (float life_in_s)
	Prolongs the lifetime of the light in seconds. Use negative number to shorten its lifetime.
void	AttachOnMemoryPoint (Object parent, string memory_point_start, string memory_point_target="")
	Attaches this light on the parent entity's memory point, with optional direction target memory point.
void	AttachOnObject (Object parent, vector local_pos="0 0 0", vector local_ori="0 0 0")
	Attaches this light on the parent entity, with optional position and orientation offset.
void	CheckFadeOut (int current_time)
void	CheckIfParentIsInCargo ()
bool	CheckLifetime (int current_time)
void	CorrectLightPulseDuringDaylight ()
	Call this after using SetBrightness(...) to fix light's intensity during daytime.
void	DeleteLightNow ()
void	DeleteLightWithDelay ()
	Correct way of deleting light from memory. It is necesarry to have this delay due to hierarchy.
void	Destroy ()
	Switches off the light and deletes it from memory.
void	DetachFromParent ()
	Detaches this light from its parent entity.
void	EnableDebug (bool state)
	Enables some debug functionality of this light.
void	EnableDimming (float baseBrightness, DimmingConfig dimCfg)
override void	EOnFrame (IEntity other, float timeSlice)
	On frame event. If you want to control your light within your own rules then override the event OnFrameLightSource and put your code there.
void	FadeBrightnessTo (float value, float time_in_s)
	Fades the brightness of the light to the given value.
void	FadeIn (float time_in_s)
	Makes the light fade into existence. Works only at the moment the light is created. Consider using FadeBrightnessTo(...) and FadeRadiusTo(...) at anytime later during lifetime.
void	FadeOut (float time_in_s=-1)
	Starts the fade out process and destroys the light when its done. Optional parameter allows you to set time of this fade out in seconds. If not set, then default value (from SetFadeOutTime(...)) is used.
void	FadeRadiusTo (float value, float time_in_s)
	Fades the radius of the light to the given value.
Object	GetAttachmentParent ()
	Returns attachment parent.
float	GetBlinkingSpeed ()
	Returns the speed of blinks.
float	GetDancingShadowsAmplitude ()
	Returns max movement range of pointlight within the dancing shadow effect.
float	GetDancingShadowsMovementSpeed ()
	Returns max movement speed of pointlight within the dancing shadow effect.
LightDimming	GetDimming ()
float	GetDisableShadowsWithinRadius ()
	Returns the range you put inside SetDisableShadowsWithinRadius(...).
float	GetFlickerAmplitudeCoefMax ()
	Returns flicker amplitude maximum.
float	GetFlickerAmplitudeCoefMin ()
	Returns flicker amplitude minimum.
float	GetFlickerSpeed ()
	Returns flicker speed.
void	HandleBlinking (float time)
void	HandleBrightnessFadeing (float timeSlice)
void	HandleDancingShadows (float time, float timeSlice)
void	HandleFlickering (float time, float timeSlice)
void	HandleRadiusFadeing (float timeSlice)
void	OnFrameLightSource (IEntity other, float timeSlice)
	Override this for custom functionality.
void	SetBlinkingSpeed (float _speed)
	Sets blinking speed (no blinking if speed <= 0).
void	SetBrightnessTo (float value)
	Sets the brightness of the light.
void	SetDancingShadowsAmplitude (float max_deviation_in_meters)
	Sets the maximum range of the point light within the dancing shadows effect.
void	SetDancingShadowsMovementSpeed (float speed_in_meters_per_frame)
	Sets the maximum speed of the point light within the dancing shadows effect.
void	SetDisableShadowsWithinRadius (float radius_in_m)
	When the light source gets within this radius (radius_in_m) around the camera, then it's shadows are disabled.
void	SetFadeOutTime (float time_in_s)
	Sets the fade out time in seconds. Fade out begins automatically as the light nears the end of its life time, or when method FadeOut() is called.
void	SetFlickerAmplitude (float coef)
	Sets the change coefficient of flickering light. (0.0 - 1.0 values, result of greater values are period time of light off ).
void	SetFlickerAmplitudeMax (float coef)
void	SetFlickerAmplitudeMin (float coef)
void	SetFlickerSpeed (float speed)
	Sets speed of light flickering (random brightness coefficient change per second).
void	SetLifetime (float life_in_s)
	Makes the light destroy itself after the given time in seconds. The light will fade out if it's set to do so with SetFadeOutTime(...).
void	SetRadiusTo (float value)
	Sets the radius of the light.
void	SetSelectionID (int id)
void	StopDimming ()
void	TryShadowOptimization ()
	Optimizes shadows by disabling them on this light source while it's within the given radius around the camera.
void	UpdateLightMode (string slotName)
void	UpdateLightSourceMaterial (string path)

Static Private Member Functions
static ScriptedLightBase	CreateLight (typename name, vector global_pos="0 0 0", float fade_in_time_in_s=0)
	Creates an instance of light on the given position. Optionally, use fade_in_time_in_s parameter to make the light fade into existence.
static ScriptedLightBase	CreateLightAtObjMemoryPoint (typename name, notnull Object target, string memory_point_start, string memory_point_target="", vector global_pos="0 0 0", float fade_in_time_in_s=0)

Detailed Description

Definition at line 10 of file scriptedlightbase.c.

Constructor & Destructor Documentation

◆ ~ScriptedLightBase()

void ~ScriptedLightBase ( )

inlineprotected

Definition at line 55 of file scriptedlightbase.c.

References m_NightTimeOnlyLights.

Member Function Documentation

◆ AddLifetime()

void AddLifetime ( float life_in_s )

inlineprivate

Prolongs the lifetime of the light in seconds. Use negative number to shorten its lifetime.

Definition at line 376 of file scriptedlightbase.c.

References m_LifetimeEnd.

◆ AttachOnMemoryPoint()

void AttachOnMemoryPoint	(	Object	parent,
		string	memory_point_start,
		string	memory_point_target = "" )

inlineprivate

Attaches this light on the parent entity's memory point, with optional direction target memory point.

Definition at line 162 of file scriptedlightbase.c.

References AttachOnObject(), vector::Direction(), ErrorEx, m_LocalPos, UpdateMode(), and vector::VectorToAngles().

◆ AttachOnObject()

void AttachOnObject	(	Object	parent,
		vector	local_pos = "0 0 0",
		vector	local_ori = "0 0 0" )

inlineprivate

Attaches this light on the parent entity, with optional position and orientation offset.

Definition at line 127 of file scriptedlightbase.c.

References m_LocalOri, m_LocalPos, m_Parent, and SetPosition().

Referenced by AttachOnMemoryPoint().

◆ CheckFadeOut()

void CheckFadeOut ( int current_time )

inlineprivate

Definition at line 645 of file scriptedlightbase.c.

References FadeBrightnessTo(), FadeRadiusTo(), m_FadeInTime, m_FadeOutTime, and m_LifetimeEnd.

Referenced by EOnFrame().

◆ CheckIfParentIsInCargo()

void CheckIfParentIsInCargo ( )

inlineprivate

Definition at line 593 of file scriptedlightbase.c.

References GameInventory::IsInCargo(), m_Parent, and SetEnabled().

Referenced by EOnFrame().

◆ CheckLifetime()

bool CheckLifetime ( int current_time )

inlineprivate

Definition at line 633 of file scriptedlightbase.c.

References Destroy(), and m_LifetimeEnd.

Referenced by EOnFrame().

◆ CorrectLightPulseDuringDaylight()

void CorrectLightPulseDuringDaylight ( )

inlineprivate

Call this after using SetBrightness(...) to fix light's intensity during daytime.

Definition at line 264 of file scriptedlightbase.c.

References m_Brightness, and m_BrightnessPulse.

Referenced by HandleBrightnessFadeing(), and SetBrightnessTo().

◆ CreateLight()

ScriptedLightBase CreateLight	(	typename name	,
		vector	global_pos = "0 0 0",
		float	fade_in_time_in_s = 0 )

inlinestaticprivate

Creates an instance of light on the given position. Optionally, use fade_in_time_in_s parameter to make the light fade into existence.

Definition at line 224 of file scriptedlightbase.c.

References Error(), g_Game, name, and ScriptedLightBase().

◆ CreateLightAtObjMemoryPoint()

ScriptedLightBase CreateLightAtObjMemoryPoint	(	typename name	,
		notnull Object	target,
		string	memory_point_start,
		string	memory_point_target = "",
		vector	global_pos = "0 0 0",
		float	fade_in_time_in_s = 0 )

inlinestaticprivate

Definition at line 212 of file scriptedlightbase.c.

References CreateLight(), name, and ScriptedLightBase().

◆ DeleteLightNow()

void DeleteLightNow ( )

inlineprivate

Definition at line 121 of file scriptedlightbase.c.

References g_Game.

Referenced by Destroy().

◆ DeleteLightWithDelay()

void DeleteLightWithDelay ( )

inlineprivate

Correct way of deleting light from memory. It is necesarry to have this delay due to hierarchy.

Definition at line 106 of file scriptedlightbase.c.

References CALL_CATEGORY_SYSTEM, DetachFromParent(), g_Game, and m_DeleteTimer.

Referenced by Destroy().

◆ Destroy()

void Destroy ( )

inlineprivate

Switches off the light and deletes it from memory.

Definition at line 323 of file scriptedlightbase.c.

References DeleteLightNow(), DeleteLightWithDelay(), m_Parent, and SetEnabled().

◆ DetachFromParent()

void DetachFromParent ( )

inlineprivate

Detaches this light from its parent entity.

Definition at line 192 of file scriptedlightbase.c.

References GetParent(), m_LocalOri, m_LocalPos, m_Parent, and Vector().

Referenced by DeleteLightWithDelay().

◆ EnableDebug()

void EnableDebug ( bool state )

inlineprivate

Enables some debug functionality of this light.

Definition at line 457 of file scriptedlightbase.c.

References m_IsDebugEnabled.

◆ EnableDimming()

void EnableDimming	(	float	baseBrightness,
		DimmingConfig	dimCfg )

inlineprivate

Definition at line 750 of file scriptedlightbase.c.

References LightDimming(), and m_LightDimming.

◆ EOnFrame()

override void EOnFrame	(	IEntity	other,
		float	timeSlice )

inlineprivate

On frame event. If you want to control your light within your own rules then override the event OnFrameLightSource and put your code there.

Definition at line 388 of file scriptedlightbase.c.

References CheckFadeOut(), CheckIfParentIsInCargo(), CheckLifetime(), g_Game, HandleBlinking(), HandleBrightnessFadeing(), HandleDancingShadows(), HandleFlickering(), HandleRadiusFadeing(), m_LifetimeStart, m_LightDimming, m_Radius, OnFrameLightSource(), SetRadius(), and TryShadowOptimization().

◆ EOnInit()

override void EOnInit	(	IEntity	other,
		int	extra )

inlineprotected

Definition at line 67 of file scriptedlightbase.c.

References g_Game, and m_NightTimeOnlyLights.

◆ FadeBrightnessTo()

void FadeBrightnessTo	(	float	value,
		float	time_in_s )

inlineprivate

Fades the brightness of the light to the given value.

Definition at line 285 of file scriptedlightbase.c.

References Math::AbsFloat(), m_Brightness, m_BrightnessSpeedOfChange, and m_BrightnessTarget.

Referenced by CheckFadeOut(), FadeIn(), and FadeOut().

◆ FadeIn()

void FadeIn ( float time_in_s )

inlineprivate

Makes the light fade into existence. Works only at the moment the light is created. Consider using FadeBrightnessTo(...) and FadeRadiusTo(...) at anytime later during lifetime.

Definition at line 368 of file scriptedlightbase.c.

References FadeBrightnessTo(), m_Brightness, and SetBrightnessTo().

◆ FadeOut()

void FadeOut ( float time_in_s = -1 )

inlineprivate

Starts the fade out process and destroys the light when its done. Optional parameter allows you to set time of this fade out in seconds. If not set, then default value (from SetFadeOutTime(...)) is used.

Definition at line 347 of file scriptedlightbase.c.

References FadeBrightnessTo(), FadeRadiusTo(), m_FadeOutTime, and SetLifetime().

◆ FadeRadiusTo()

void FadeRadiusTo	(	float	value,
		float	time_in_s )

inlineprivate

Fades the radius of the light to the given value.

Definition at line 308 of file scriptedlightbase.c.

References Math::AbsFloat(), m_Radius, m_RadiusSpeedOfChange, and m_RadiusTarget.

Referenced by CheckFadeOut(), and FadeOut().

◆ GetAttachmentParent()

Object GetAttachmentParent ( )

inlineprivate

Returns attachment parent.

Definition at line 156 of file scriptedlightbase.c.

References m_Parent.

◆ GetBlinkingSpeed()

float GetBlinkingSpeed ( )

inlineprivate

Returns the speed of blinks.

Definition at line 729 of file scriptedlightbase.c.

References m_BlinkingSpeed.

◆ GetDancingShadowsAmplitude()

float GetDancingShadowsAmplitude ( )

inlineprivate

Returns max movement range of pointlight within the dancing shadow effect.

Definition at line 431 of file scriptedlightbase.c.

References m_DancingShadowsAmplitude.

◆ GetDancingShadowsMovementSpeed()

float GetDancingShadowsMovementSpeed ( )

inlineprivate

Returns max movement speed of pointlight within the dancing shadow effect.

Definition at line 437 of file scriptedlightbase.c.

References m_DancingShadowsSpeed.

◆ GetDimming()

LightDimming GetDimming ( )

inlineprivate

Definition at line 756 of file scriptedlightbase.c.

References LightDimming(), and m_LightDimming.

◆ GetDisableShadowsWithinRadius()

float GetDisableShadowsWithinRadius ( )

inlineprivate

Returns the range you put inside SetDisableShadowsWithinRadius(...).

Definition at line 588 of file scriptedlightbase.c.

References m_OptimizeShadowsRadius.

◆ GetFlickerAmplitudeCoefMax()

float GetFlickerAmplitudeCoefMax ( )

inlineprivate

Returns flicker amplitude maximum.

Definition at line 552 of file scriptedlightbase.c.

References m_BrightnessPulseAmplitudeMax.

◆ GetFlickerAmplitudeCoefMin()

float GetFlickerAmplitudeCoefMin ( )

inlineprivate

Returns flicker amplitude minimum.

Definition at line 558 of file scriptedlightbase.c.

References m_BrightnessPulseAmplitudeMin.

◆ GetFlickerSpeed()

float GetFlickerSpeed ( )

inlineprivate

Returns flicker speed.

Definition at line 546 of file scriptedlightbase.c.

References m_BrightnessPulseSpeed.

◆ HandleBlinking()

void HandleBlinking ( float time )

inlineprivate

Definition at line 735 of file scriptedlightbase.c.

References m_BlinkingSpeed, m_Brightness, Math::Round(), and Math::Sin().

Referenced by EOnFrame().

◆ HandleBrightnessFadeing()

void HandleBrightnessFadeing ( float timeSlice )

inlineprivate

Definition at line 659 of file scriptedlightbase.c.

References CorrectLightPulseDuringDaylight(), Destroy(), m_Brightness, m_BrightnessPulse, m_BrightnessSpeedOfChange, and m_BrightnessTarget.

Referenced by EOnFrame().

◆ HandleDancingShadows()

void HandleDancingShadows	(	float	time,
		float	timeSlice )

inlineprivate

Definition at line 463 of file scriptedlightbase.c.

References ParticleList::DEBUG_DOT, GetPosition(), m_DancingShadowsAmplitude, m_DancingShadowsLocalPos, m_DancingShadowsSpeed, m_IsDebugEnabled, m_LocalPos, m_Parent, ParticleManager(), Math::RandomFloat(), Particle::SetParticleParam(), SetPosition(), and Vector().

Referenced by EOnFrame().

◆ HandleFlickering()

void HandleFlickering	(	float	time,
		float	timeSlice )

inlineprivate

Definition at line 503 of file scriptedlightbase.c.

References m_BrightnessPulse, m_BrightnessPulseAmplitudeMax, m_BrightnessPulseAmplitudeMin, m_BrightnessPulseSpeed, and Math::RandomFloat().

Referenced by EOnFrame().

◆ HandleRadiusFadeing()

void HandleRadiusFadeing ( float timeSlice )

inlineprivate

Definition at line 692 of file scriptedlightbase.c.

References Destroy(), m_Radius, m_RadiusSpeedOfChange, m_RadiusTarget, and SetRadius().

Referenced by EOnFrame().

◆ IsScriptedLight()

override bool IsScriptedLight ( )

inlineprotected

Definition at line 78 of file scriptedlightbase.c.

◆ OnFrameLightSource()

void OnFrameLightSource	(	IEntity	other,
		float	timeSlice )

inlineprivate

Override this for custom functionality.

Definition at line 382 of file scriptedlightbase.c.

Referenced by EOnFrame().

◆ ScriptedLightBase()

void ScriptedLightBase ( )

inlineprotected

Constructor. Everything here is executed before the constructor of all children.

Definition at line 47 of file scriptedlightbase.c.

References g_Game, m_LifetimeStart, and SetEnabled().

Referenced by CreateLight(), and CreateLightAtObjMemoryPoint().

◆ SetBlinkingSpeed()

void SetBlinkingSpeed ( float _speed )

inlineprivate

Sets blinking speed (no blinking if speed <= 0).

Definition at line 723 of file scriptedlightbase.c.

References m_BlinkingSpeed.

◆ SetBrightnessTo()

void SetBrightnessTo ( float value )

inlineprivate

Sets the brightness of the light.

Definition at line 255 of file scriptedlightbase.c.

References CorrectLightPulseDuringDaylight(), m_Brightness, m_BrightnessPulse, and m_BrightnessTarget.

Referenced by FadeIn().

◆ SetDancingShadowsAmplitude()

void SetDancingShadowsAmplitude ( float max_deviation_in_meters )

inlineprivate

Sets the maximum range of the point light within the dancing shadows effect.

Definition at line 419 of file scriptedlightbase.c.

References Math::AbsFloat(), and m_DancingShadowsAmplitude.

◆ SetDancingShadowsMovementSpeed()

void SetDancingShadowsMovementSpeed ( float speed_in_meters_per_frame )

inlineprivate

Sets the maximum speed of the point light within the dancing shadows effect.

Definition at line 425 of file scriptedlightbase.c.

References Math::AbsFloat(), and m_DancingShadowsSpeed.

◆ SetDisableShadowsWithinRadius()

void SetDisableShadowsWithinRadius ( float radius_in_m )

inlineprivate

When the light source gets within this radius (radius_in_m) around the camera, then it's shadows are disabled.

Definition at line 582 of file scriptedlightbase.c.

References m_OptimizeShadowsRadius.

◆ SetFadeOutTime()

void SetFadeOutTime ( float time_in_s )

inlineprivate

Sets the fade out time in seconds. Fade out begins automatically as the light nears the end of its life time, or when method FadeOut() is called.

Definition at line 341 of file scriptedlightbase.c.

References m_FadeOutTime.

◆ SetFlickerAmplitude()

void SetFlickerAmplitude ( float coef )

inlineprivate

Sets the change coefficient of flickering light. (0.0 - 1.0 values, result of greater values are period time of light off ).

Definition at line 529 of file scriptedlightbase.c.

References Math::AbsFloat(), m_BrightnessPulseAmplitudeMax, and m_BrightnessPulseAmplitudeMin.

◆ SetFlickerAmplitudeMax()

void SetFlickerAmplitudeMax ( float coef )

inlineprivate

Definition at line 535 of file scriptedlightbase.c.

References m_BrightnessPulseAmplitudeMax.

◆ SetFlickerAmplitudeMin()

void SetFlickerAmplitudeMin ( float coef )

inlineprivate

Definition at line 540 of file scriptedlightbase.c.

References m_BrightnessPulseAmplitudeMin.

◆ SetFlickerSpeed()

void SetFlickerSpeed ( float speed )

inlineprivate

Sets speed of light flickering (random brightness coefficient change per second).

Definition at line 523 of file scriptedlightbase.c.

References m_BrightnessPulseSpeed.

◆ SetLifetime()

void SetLifetime ( float life_in_s )

inlineprivate

Makes the light destroy itself after the given time in seconds. The light will fade out if it's set to do so with SetFadeOutTime(...).

Definition at line 334 of file scriptedlightbase.c.

References g_Game, and m_LifetimeEnd.

Referenced by FadeOut().

◆ SetRadiusTo()

void SetRadiusTo ( float value )

inlineprivate

Sets the radius of the light.

Definition at line 300 of file scriptedlightbase.c.

References m_Radius, m_RadiusTarget, and SetRadius().

◆ SetSelectionID()

void SetSelectionID ( int id )

inlineprivate

Definition at line 443 of file scriptedlightbase.c.

References m_HiddenSelectionID.

◆ StopDimming()

void StopDimming ( )

inlineprivate

Definition at line 761 of file scriptedlightbase.c.

References m_LightDimming.

◆ TryShadowOptimization()

void TryShadowOptimization ( )

inlineprivate

Optimizes shadows by disabling them on this light source while it's within the given radius around the camera.

Definition at line 564 of file scriptedlightbase.c.

References vector::Distance(), g_Game, GetPosition(), and m_OptimizeShadowsRadius.

Referenced by EOnFrame().

◆ UpdateLightMode()

void UpdateLightMode ( string slotName )

private

References slotName.

Referenced by UpdateMode().

◆ UpdateLightSourceMaterial()

void UpdateLightSourceMaterial ( string path )

inlineprivate

Definition at line 449 of file scriptedlightbase.c.

References m_HiddenSelectionID, m_Parent, and path.

◆ UpdateMode()

void UpdateMode ( )

inlineprotected

Definition at line 83 of file scriptedlightbase.c.

References InventoryLocation::GetSlot(), InventorySlots::GetSlotName(), InventoryLocation::GetType(), m_Parent, slotName, and UpdateLightMode().

Referenced by AttachOnMemoryPoint().

Field Documentation

◆ m_BlinkingSpeed

float m_BlinkingSpeed

private

Definition at line 31 of file scriptedlightbase.c.

Referenced by GetBlinkingSpeed(), HandleBlinking(), and SetBlinkingSpeed().

◆ m_Brightness

float m_Brightness

private

Definition at line 18 of file scriptedlightbase.c.

Referenced by CorrectLightPulseDuringDaylight(), FadeBrightnessTo(), FadeIn(), HandleBlinking(), HandleBrightnessFadeing(), and SetBrightnessTo().

◆ m_BrightnessPulse

float m_BrightnessPulse

private

Definition at line 19 of file scriptedlightbase.c.

Referenced by CorrectLightPulseDuringDaylight(), HandleBrightnessFadeing(), HandleFlickering(), and SetBrightnessTo().

◆ m_BrightnessPulseAmplitudeMax

float m_BrightnessPulseAmplitudeMax

private

Definition at line 21 of file scriptedlightbase.c.

Referenced by GetFlickerAmplitudeCoefMax(), HandleFlickering(), SetFlickerAmplitude(), and SetFlickerAmplitudeMax().

◆ m_BrightnessPulseAmplitudeMin

float m_BrightnessPulseAmplitudeMin

private

Definition at line 22 of file scriptedlightbase.c.

Referenced by GetFlickerAmplitudeCoefMin(), HandleFlickering(), SetFlickerAmplitude(), and SetFlickerAmplitudeMin().

◆ m_BrightnessPulseSpeed

float m_BrightnessPulseSpeed

private

Definition at line 20 of file scriptedlightbase.c.

Referenced by GetFlickerSpeed(), HandleFlickering(), and SetFlickerSpeed().

◆ m_BrightnessSpeedOfChange

float m_BrightnessSpeedOfChange = 1

private

Definition at line 24 of file scriptedlightbase.c.

Referenced by FadeBrightnessTo(), and HandleBrightnessFadeing().

◆ m_BrightnessTarget

float m_BrightnessTarget

private

Definition at line 23 of file scriptedlightbase.c.

Referenced by FadeBrightnessTo(), HandleBrightnessFadeing(), and SetBrightnessTo().

◆ m_DancingShadowsAmplitude

float m_DancingShadowsAmplitude

private

Definition at line 28 of file scriptedlightbase.c.

Referenced by GetDancingShadowsAmplitude(), HandleDancingShadows(), and SetDancingShadowsAmplitude().

◆ m_DancingShadowsLocalPos

vector m_DancingShadowsLocalPos

protected

Definition at line 39 of file scriptedlightbase.c.

Referenced by HandleDancingShadows().

◆ m_DancingShadowsSpeed

float m_DancingShadowsSpeed

private

Definition at line 29 of file scriptedlightbase.c.

Referenced by GetDancingShadowsMovementSpeed(), HandleDancingShadows(), and SetDancingShadowsMovementSpeed().

◆ m_DeleteTimer

ref Timer m_DeleteTimer

protected

Definition at line 41 of file scriptedlightbase.c.

Referenced by DeleteLightWithDelay().

◆ m_FadeInTime

float m_FadeInTime = -1

private

Definition at line 15 of file scriptedlightbase.c.

Referenced by CheckFadeOut().

◆ m_FadeOutTime

float m_FadeOutTime = -1

private

Definition at line 14 of file scriptedlightbase.c.

Referenced by CheckFadeOut(), FadeOut(), and SetFadeOutTime().

◆ m_HiddenSelectionID

int m_HiddenSelectionID

protected

Definition at line 32 of file scriptedlightbase.c.

Referenced by SetSelectionID(), and UpdateLightSourceMaterial().

◆ m_IsDebugEnabled

bool m_IsDebugEnabled = false

protected

Definition at line 34 of file scriptedlightbase.c.

Referenced by EnableDebug(), and HandleDancingShadows().

◆ m_LifetimeEnd

float m_LifetimeEnd = -1

private

Definition at line 13 of file scriptedlightbase.c.

Referenced by AddLifetime(), CheckFadeOut(), CheckLifetime(), and SetLifetime().

◆ m_LifetimeStart

float m_LifetimeStart

private

Definition at line 12 of file scriptedlightbase.c.

Referenced by EOnFrame(), and ScriptedLightBase().

◆ m_LightDimming

ref LightDimming m_LightDimming

protected

Definition at line 42 of file scriptedlightbase.c.

Referenced by EnableDimming(), EOnFrame(), GetDimming(), and StopDimming().

◆ m_LocalOri

vector m_LocalOri

protected

Definition at line 38 of file scriptedlightbase.c.

Referenced by AttachOnObject(), and DetachFromParent().

◆ m_LocalPos

vector m_LocalPos

protected

Definition at line 37 of file scriptedlightbase.c.

Referenced by AttachOnMemoryPoint(), AttachOnObject(), DetachFromParent(), and HandleDancingShadows().

◆ m_NightTimeOnlyLights

ref set<ScriptedLightBase> m_NightTimeOnlyLights = new set<ScriptedLightBase>()

staticprotected

Definition at line 44 of file scriptedlightbase.c.

Referenced by ~ScriptedLightBase(), and EOnInit().

◆ m_OptimizeShadowsRadius

float m_OptimizeShadowsRadius = 0

private

Definition at line 26 of file scriptedlightbase.c.

Referenced by GetDisableShadowsWithinRadius(), SetDisableShadowsWithinRadius(), and TryShadowOptimization().

◆ m_Parent

Object m_Parent

protected

Definition at line 36 of file scriptedlightbase.c.

Referenced by AttachOnObject(), CheckIfParentIsInCargo(), Destroy(), DetachFromParent(), GetAttachmentParent(), HandleDancingShadows(), UpdateLightSourceMaterial(), and UpdateMode().

◆ m_Radius

float m_Radius

private

Definition at line 16 of file scriptedlightbase.c.

Referenced by EOnFrame(), FadeRadiusTo(), HandleRadiusFadeing(), and SetRadiusTo().

◆ m_RadiusSpeedOfChange

float m_RadiusSpeedOfChange = 1

private

Definition at line 25 of file scriptedlightbase.c.

Referenced by FadeRadiusTo(), and HandleRadiusFadeing().

◆ m_RadiusTarget

float m_RadiusTarget

private

Definition at line 17 of file scriptedlightbase.c.

Referenced by FadeRadiusTo(), HandleRadiusFadeing(), and SetRadiusTo().

The documentation for this class was generated from the following file:

F:/Games/Dayz/scripts/4_world/entities/scriptedlightbase.c

Private Attributes
float	m_BlinkingSpeed
float	m_Brightness
float	m_BrightnessPulse
float	m_BrightnessPulseAmplitudeMax
float	m_BrightnessPulseAmplitudeMin
float	m_BrightnessPulseSpeed
float	m_BrightnessSpeedOfChange = 1
float	m_BrightnessTarget
float	m_DancingShadowsAmplitude
float	m_DancingShadowsSpeed
float	m_FadeInTime = -1
float	m_FadeOutTime = -1
float	m_LifetimeEnd = -1
float	m_LifetimeStart
float	m_OptimizeShadowsRadius = 0
float	m_Radius
float	m_RadiusSpeedOfChange = 1
float	m_RadiusTarget

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~ScriptedLightBase()

Member Function Documentation

◆ AddLifetime()

◆ AttachOnMemoryPoint()

◆ AttachOnObject()

◆ CheckFadeOut()

◆ CheckIfParentIsInCargo()

◆ CheckLifetime()

◆ CorrectLightPulseDuringDaylight()

◆ CreateLight()

◆ CreateLightAtObjMemoryPoint()

◆ DeleteLightNow()

◆ DeleteLightWithDelay()

◆ Destroy()

◆ DetachFromParent()

◆ EnableDebug()

◆ EnableDimming()

◆ EOnFrame()

◆ EOnInit()

◆ FadeBrightnessTo()

◆ FadeIn()

◆ FadeOut()

◆ FadeRadiusTo()

◆ GetAttachmentParent()

◆ GetBlinkingSpeed()

◆ GetDancingShadowsAmplitude()

◆ GetDancingShadowsMovementSpeed()

◆ GetDimming()

◆ GetDisableShadowsWithinRadius()

◆ GetFlickerAmplitudeCoefMax()

◆ GetFlickerAmplitudeCoefMin()

◆ GetFlickerSpeed()

◆ HandleBlinking()

◆ HandleBrightnessFadeing()

◆ HandleDancingShadows()

◆ HandleFlickering()

◆ HandleRadiusFadeing()

◆ IsScriptedLight()

◆ OnFrameLightSource()

◆ ScriptedLightBase()

◆ SetBlinkingSpeed()

◆ SetBrightnessTo()

◆ SetDancingShadowsAmplitude()

◆ SetDancingShadowsMovementSpeed()

◆ SetDisableShadowsWithinRadius()

◆ SetFadeOutTime()

◆ SetFlickerAmplitude()

◆ SetFlickerAmplitudeMax()

◆ SetFlickerAmplitudeMin()

◆ SetFlickerSpeed()

◆ SetLifetime()

◆ SetRadiusTo()

◆ SetSelectionID()

◆ StopDimming()

◆ TryShadowOptimization()

◆ UpdateLightMode()

◆ UpdateLightSourceMaterial()

◆ UpdateMode()

Field Documentation

◆ m_BlinkingSpeed

◆ m_Brightness

◆ m_BrightnessPulse

◆ m_BrightnessPulseAmplitudeMax

◆ m_BrightnessPulseAmplitudeMin

◆ m_BrightnessPulseSpeed

◆ m_BrightnessSpeedOfChange

◆ m_BrightnessTarget

◆ m_DancingShadowsAmplitude

◆ m_DancingShadowsLocalPos

◆ m_DancingShadowsSpeed

◆ m_DeleteTimer

◆ m_FadeInTime