Класс EntityLightSource

Закрытые члены
void	ScriptedLightBase ()
	Constructor. Everything here is executed before the constructor of all children.
void	~ScriptedLightBase ()
override void	EOnInit (IEntity other, int extra)
override bool	IsScriptedLight ()
void	UpdateMode ()
void	UpdateLightMode (string slotName)
void	DeleteLightWithDelay ()
	Correct way of deleting light from memory. It is necesarry to have this delay due to hierarchy.
void	DeleteLightNow ()
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.
Object	GetAttachmentParent ()
	Returns attachment parent.
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	DetachFromParent ()
	Detaches this light from its parent entity.
void	SetBrightnessTo (float value)
	Sets the brightness of the light.
void	CorrectLightPulseDuringDaylight ()
	Call this after using SetBrightness(...) to fix light's intensity during daytime.
void	FadeBrightnessTo (float value, float time_in_s)
	Fades the brightness of the light to the given value.
void	SetRadiusTo (float value)
	Sets the radius of the light.
void	FadeRadiusTo (float value, float time_in_s)
	Fades the radius of the light to the given value.
void	Destroy ()
	Switches off the light and deletes it from memory.
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	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	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	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	AddLifetime (float life_in_s)
	Prolongs the lifetime of the light in seconds. Use negative number to shorten its lifetime.
void	OnFrameLightSource (IEntity other, float timeSlice)
	Override this for custom functionality.
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	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.
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.
void	EnableDebug (bool state)
	Enables some debug functionality of this light.
void	HandleDancingShadows (float time, float timeSlice)
void	HandleFlickering (float time, float timeSlice)
void	SetFlickerSpeed (float speed)
	Sets speed of light flickering (random brightness coefficient change per second)
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)
float	GetFlickerSpeed ()
	Returns flicker speed.
float	GetFlickerAmplitudeCoefMax ()
	Returns flicker amplitude maximum.
float	GetFlickerAmplitudeCoefMin ()
	Returns flicker amplitude minimum.
void	TryShadowOptimization ()
	Optimizes shadows by disabling them on this light source while it's within the given radius around the camera.
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.
float	GetDisableShadowsWithinRadius ()
	Returns the range you put inside SetDisableShadowsWithinRadius(...)
void	CheckIfParentIsInCargo ()
bool	CheckLifetime (int current_time)
void	CheckFadeOut (int current_time)
void	HandleBrightnessFadeing (float timeSlice)
void	HandleRadiusFadeing (float timeSlice)
void	SetBlinkingSpeed (float _speed)
	Sets blinking speed (no blinking if speed <= 0)
float	GetBlinkingSpeed ()
	Returns the speed of blinks.
void	HandleBlinking (float time)

Закрытые статические члены
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)
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.

Закрытые данные
float	m_LifetimeStart
float	m_LifetimeEnd = -1
float	m_FadeOutTime = -1
float	m_FadeInTime = -1
float	m_Radius
float	m_RadiusTarget
float	m_Brightness
float	m_BrightnessPulse
float	m_BrightnessPulseSpeed
float	m_BrightnessPulseAmplitudeMax
float	m_BrightnessPulseAmplitudeMin
float	m_BrightnessTarget
float	m_BrightnessSpeedOfChange = 1
float	m_RadiusSpeedOfChange = 1
float	m_OptimizeShadowsRadius = 0
float	m_DancingShadowsAmplitude
float	m_DancingShadowsSpeed
float	m_BlinkingSpeed
bool	m_IsDebugEnabled = false
Object	m_Parent
vector	m_LocalPos
vector	m_LocalOri
vector	m_DancingShadowsLocalPos
ref Timer	m_DeleteTimer

Закрытые статические данные
static ref set< ScriptedLightBase >	m_NightTimeOnlyLights = new set<ScriptedLightBase>()

Подробное описание

Конструктор(ы)

~ScriptedLightBase()

void ~ScriptedLightBase ( )

inlineprivate

    {
        if (m_NightTimeOnlyLights)
        {
            int index = m_NightTimeOnlyLights.Find(this);
            if (index != -1)
            {
                m_NightTimeOnlyLights.Remove(index);
            }
        }
    }

Методы

AddLifetime()

void AddLifetime ( float life_in_s )

inlineprivate

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

    {
        m_LifetimeEnd += life_in_s * 1000;
    }

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.

    {
        if (parent.MemoryPointExists(memory_point_start))
        {
            m_LocalPos = parent.GetMemoryPointPos(memory_point_start);
            vector local_ori;
            
            if (memory_point_target != "" )
            {
                if (parent.MemoryPointExists(memory_point_target))
                {
                    vector target_pos = parent.GetSelectionPositionLS(memory_point_target);
                    target_pos = vector.Direction(m_LocalPos, target_pos);
                    local_ori = target_pos.VectorToAngles();
                }
                else
                {
                    ErrorEx("memory point 'memory_point_target' not found when attaching light");
                }
            }
            AttachOnObject(parent, m_LocalPos, local_ori);  
            UpdateMode();
        }
        else
        {
            ErrorEx("memory point 'memory_point_start' not found when attaching light");
        }
    }

Перекрестные ссылки vector::Direction(), ErrorEx и m_LocalPos.

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.

    {
        if (!parent)
        {
            if (m_Parent)
            {
                m_Parent.RemoveChild(this);
            }
            
            return;
        }
        else
        {
            if (m_Parent)
            {
                m_Parent.RemoveChild(this);
            }
        }
        
        m_Parent = parent;
        m_LocalPos = local_pos;
        m_LocalOri = local_ori;
        SetOrientation(local_ori);
        SetPosition(local_pos);
        parent.AddChild(this, -1);
        parent.Update();
    }

Перекрестные ссылки m_LocalOri, m_LocalPos, m_Parent и SetPosition().

CheckFadeOut()

void CheckFadeOut ( int current_time )

inlineprivate

    {
        // Control fade out of the light
        if ( m_FadeOutTime != -1  &&  m_LifetimeEnd != -1  &&  current_time > m_LifetimeEnd - m_FadeOutTime )
        {
            m_FadeOutTime = -1;
            m_FadeInTime = -1; // Stop fade in process
            float time_left_in_s = (m_LifetimeEnd - current_time) * 0.001;
            FadeBrightnessTo(0, time_left_in_s);
            FadeRadiusTo(0, time_left_in_s);
        }
    }

CheckIfParentIsInCargo()

void CheckIfParentIsInCargo ( )

inlineprivate

    {
        // TO DO: OPTIMIZE AND REFACTOR! THIS MUST BE HANDLED IN AN EVENT, NOT PER FRAME!
        
        if (m_Parent)
        {
            EntityAI parent_EAI = EntityAI.Cast( m_Parent );
            
            if (parent_EAI) // Check if the Cast was successfull
            {
                GameInventory GI = parent_EAI.GetInventory();
                
                if (GI) // Prevents handling of light on the parent item when it's projected in inventory as the item in inventory character's hands.
                {
                    bool is_in_cargo = GI.IsInCargo();
                    
                    if (!is_in_cargo)
                    {
                        EntityAI parent2 = parent_EAI.GetHierarchyParent();
                        
                        if (parent2  &&  parent2.GetInventory())
                        {
                            is_in_cargo = parent2.GetInventory().IsInCargo();
                        }
                    }
                    
                    if ( is_in_cargo )
                    {
                        SetEnabled(false);
                    }
                    else
                    {
                        SetEnabled(true);
                    }
                }
            }
        }
    }

Перекрестные ссылки m_Parent и SetEnabled().

CheckLifetime()

bool CheckLifetime ( int current_time )

inlineprivate

    {
        if ( current_time > m_LifetimeEnd  &&  m_LifetimeEnd != -1 )
        {
            Destroy();
            return false;
        }
        
        return true;
    }

Перекрестные ссылки Destroy().

CorrectLightPulseDuringDaylight()

void CorrectLightPulseDuringDaylight ( )

inlineprivate

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

    {
        if (m_Brightness < 100)
        {
            float v = m_Brightness * 0.01;
            
            if (v > 0)
            {
                float brightness_compesation = 1 / v;
                float compenset_brightness = (m_Brightness * m_BrightnessPulse) * brightness_compesation;
                SetBrightness(compenset_brightness);
                SetPulseCoef(v);
            }
        }
        else
        {
            SetPulseCoef(1);
        }
    }

CreateLight()

static 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.

    {
        ScriptedLightBase light_instance;
        
        if ( !GetGame().IsServer()  ||  !GetGame().IsMultiplayer() ) // Client side
        {
            light_instance = ScriptedLightBase.Cast( GetGame().CreateObject(name.ToString(), global_pos, true) );
            
            if (!light_instance)
            {
                Error("Error! Light entity of name " + name.ToString() + " cannot be spawned! This name is incorrect or not inherited from ScriptedLightBase." );
                return null;
            }
            
            if (fade_in_time_in_s != 0)
            {
                light_instance.FadeIn(fade_in_time_in_s);
            }
        }
        else // Server side
        {
            if ( GetGame().IsDebug() )
            {
                Error("An instance of ScriptedLightBase was attempted to spawn on server side! Lights are CLIENT SIDE ONLY!");
            }
        }
        
        return light_instance;
    }

Перекрестные ссылки Error(), GetGame() и name.

CreateLightAtObjMemoryPoint()

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 )

inlinestaticprivate

    {
        ScriptedLightBase light;
        if (target.MemoryPointExists(memory_point_start))
        {
            light = CreateLight(name, global_pos, fade_in_time_in_s);
            light.AttachOnMemoryPoint(target, memory_point_start, memory_point_target);
        }
        return light;
    }

Перекрестные ссылки CreateLight() и name.

DeleteLightNow()

void DeleteLightNow ( )

inlineprivate

    {
        GetGame().ObjectDelete(this);
    }

Перекрестные ссылки GetGame().

DeleteLightWithDelay()

void DeleteLightWithDelay ( )

inlineprivate

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

    {
        DetachFromParent(); // This is the reason for the delay
        
        if (GetGame())
        {
            if (!m_DeleteTimer)
                m_DeleteTimer = new Timer( CALL_CATEGORY_SYSTEM );
    
            m_DeleteTimer.Run( 0.03 , this, "DeleteLightNow", NULL, true);
        }
        
    }

Перекрестные ссылки CALL_CATEGORY_SYSTEM, GetGame() и m_DeleteTimer.

Destroy()

void Destroy ( )

inlineprivate

Switches off the light and deletes it from memory.

    {
        ClearEventMask(EntityEvent.FRAME);
        SetEnabled(false);
        if (m_Parent)
            DeleteLightWithDelay();
        else
            DeleteLightNow();
    }

Перекрестные ссылки m_Parent и SetEnabled().

DetachFromParent()

void DetachFromParent ( )

inlineprivate

Detaches this light from its parent entity.

    {
        if (!m_Parent)
        {
            m_Parent = Object.Cast( GetParent() );
        }
        
        if (m_Parent)
        {
            if ( !m_Parent.ToDelete()  &&  !ToDelete() )
            {
                m_Parent.RemoveChild(this);
            }
        }
        
        m_Parent = null;
        m_LocalPos = Vector(0,0,0);
        m_LocalOri = Vector(0,0,0);
    }

Перекрестные ссылки GetParent(), m_LocalOri, m_LocalPos, m_Parent и Vector().

EnableDebug()

void EnableDebug ( bool state )

inlineprivate

Enables some debug functionality of this light.

    {
        m_IsDebugEnabled = state;
    }

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.

    {
        // Control lifetime of the light
        int current_time = GetGame().GetTime();
        
        if ( CheckLifetime(current_time) )
        {
            SetRadius(m_Radius);
        }
        else
        {
            return;
        }
        
        HandleFlickering(current_time - m_LifetimeStart, timeSlice);
        HandleDancingShadows(current_time - m_LifetimeStart, timeSlice);
        CheckFadeOut(current_time);
        HandleBrightnessFadeing(timeSlice);
        HandleRadiusFadeing(timeSlice);
        
        CheckIfParentIsInCargo();
        TryShadowOptimization();
        OnFrameLightSource(other, timeSlice);
        
        HandleBlinking(current_time);
    }

Перекрестные ссылки GetGame(), m_Radius и SetRadius().

EOnInit()

override void EOnInit ( IEntity other, int extra )

inlineprivate

    {
        if (!IsVisibleDuringDaylight())
        {
            PlayerBase player = PlayerBase.Cast(GetGame().GetPlayer());
            if (player && player.m_UndergroundPresence)
                SetVisibleDuringDaylight(true);
            m_NightTimeOnlyLights.Insert(this);
        }
    }

Перекрестные ссылки GetGame() и GetPlayer().

FadeBrightnessTo()

void FadeBrightnessTo ( float value, float time_in_s )

inlineprivate

Fades the brightness of the light to the given value.

    {
        m_BrightnessTarget = value;
        
        if (time_in_s == 0)
        {
            m_BrightnessSpeedOfChange = 9999;
        }
        else
        {
            m_BrightnessSpeedOfChange = Math.AbsFloat(m_Brightness - m_BrightnessTarget) / time_in_s;
        }
    }

Перекрестные ссылки Math::AbsFloat().

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.

    {
        float brightness = m_Brightness;
        SetBrightnessTo(0);
        FadeBrightnessTo(brightness, time_in_s);
    }

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.

    {
        float time_in_ms = time_in_s * 1000;
        
        if (time_in_s == -1)
        {
            float kill_time_in_s = m_FadeOutTime*0.001;
            
            FadeBrightnessTo(0, kill_time_in_s);
            FadeRadiusTo(0, kill_time_in_s);
            SetLifetime(kill_time_in_s);
        }
        else
        {
            FadeBrightnessTo(0, time_in_s);
            FadeRadiusTo(0, time_in_s);
            SetLifetime(time_in_s);
        }
    }

FadeRadiusTo()

void FadeRadiusTo ( float value, float time_in_s )

inlineprivate

Fades the radius of the light to the given value.

    {
        m_RadiusTarget = value;
        
        if (time_in_s == 0)
        {
            m_RadiusSpeedOfChange = 9999;
        }
        else
        {
            m_RadiusSpeedOfChange = Math.AbsFloat(m_Radius - m_RadiusTarget) / time_in_s;
        }
    }

Перекрестные ссылки Math::AbsFloat() и m_Radius.

GetAttachmentParent()

Object GetAttachmentParent ( )

inlineprivate

Returns attachment parent.

    {
        return m_Parent;
    }

Перекрестные ссылки m_Parent.

GetBlinkingSpeed()

float GetBlinkingSpeed ( )

inlineprivate

Returns the speed of blinks.

    {
        return m_BlinkingSpeed;
    }

GetDancingShadowsAmplitude()

float GetDancingShadowsAmplitude ( )

inlineprivate

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

    {
        return m_DancingShadowsAmplitude;
    }

GetDancingShadowsMovementSpeed()

float GetDancingShadowsMovementSpeed ( )

inlineprivate

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

    {
        return m_DancingShadowsSpeed;
    }

GetDisableShadowsWithinRadius()

float GetDisableShadowsWithinRadius ( )

inlineprivate

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

    {
        return m_OptimizeShadowsRadius;
    }

GetFlickerAmplitudeCoefMax()

float GetFlickerAmplitudeCoefMax ( )

inlineprivate

Returns flicker amplitude maximum.

    {
        return m_BrightnessPulseAmplitudeMax;
    }

GetFlickerAmplitudeCoefMin()

float GetFlickerAmplitudeCoefMin ( )

inlineprivate

Returns flicker amplitude minimum.

    {
        return m_BrightnessPulseAmplitudeMin;
    }

GetFlickerSpeed()

float GetFlickerSpeed ( )

inlineprivate

Returns flicker speed.

    {
        return m_BrightnessPulseSpeed;
    }

HandleBlinking()

void HandleBlinking ( float time )

inlineprivate

    {
        if ( m_BlinkingSpeed <= 0 )
            return;
        
        float multiplier;
 
        multiplier = Math.Sin(time * 0.001 * m_BlinkingSpeed);      // Oscillate the multiplier overtime (time normalized to sec)
        multiplier = (multiplier + 1)/2;                            // Normalized the value to 0-1 
        
        multiplier = Math.Round(multiplier);                        // Rounding to 0 or 1 to make it blink instantly    
        SetBrightness(m_Brightness * multiplier);
    }

Перекрестные ссылки Math::Round() и Math::Sin().

HandleBrightnessFadeing()

void HandleBrightnessFadeing ( float timeSlice )

inlineprivate

    {
        if ( m_Brightness != m_BrightnessTarget )
        {
            float brightness_difference = m_Brightness - m_BrightnessTarget;
            
            if (brightness_difference > m_BrightnessSpeedOfChange*timeSlice)
                brightness_difference = m_BrightnessSpeedOfChange*timeSlice;
            
            if (brightness_difference < -m_BrightnessSpeedOfChange*timeSlice)
                brightness_difference = -m_BrightnessSpeedOfChange*timeSlice;
            
            m_Brightness -= brightness_difference;
            
            if ( m_Brightness > 0  ||  m_BrightnessTarget > 0)
            {
                SetBrightness(m_Brightness * m_BrightnessPulse);
                CorrectLightPulseDuringDaylight();
            }
            else
            {
                Destroy();
                return;
            }
        }
        else
        {
            SetBrightness(m_Brightness * m_BrightnessPulse);
            CorrectLightPulseDuringDaylight();
        }
    }

Перекрестные ссылки Destroy().

HandleDancingShadows()

void HandleDancingShadows ( float time, float timeSlice )

inlineprivate

    {
        if (m_DancingShadowsAmplitude > 0)
        {
            for (int i = 0; i < 3; i++ )
            {
                m_DancingShadowsLocalPos[i] = m_DancingShadowsLocalPos[i] +  ( Math.RandomFloat(-m_DancingShadowsSpeed,m_DancingShadowsSpeed) * timeSlice) ;
                
                if (m_DancingShadowsLocalPos[i] > m_DancingShadowsAmplitude)
                    m_DancingShadowsLocalPos[i] = m_DancingShadowsAmplitude;
                
                if (m_DancingShadowsLocalPos[i] < -m_DancingShadowsAmplitude)
                    m_DancingShadowsLocalPos[i] = -m_DancingShadowsAmplitude;
                
            }
            
            if (m_Parent  &&  !m_Parent.ToDelete())
            {
                // In order to move with the light, it must be detached from its parent first
                
                m_Parent.RemoveChild(this);
                SetPosition(m_LocalPos + m_DancingShadowsLocalPos);
                
                m_Parent.AddChild(this, -1);
                m_Parent.Update();
            }
            
            if (m_IsDebugEnabled)
            {
                Particle p = ParticleManager.GetInstance().PlayInWorld( ParticleList.DEBUG_DOT, GetPosition() );
                p.SetParticleParam( EmitorParam.SIZE, 0.01);
            }
        }
        else
        {
            m_DancingShadowsLocalPos = Vector(0,0,0);
        }
    }

Перекрестные ссылки ParticleList::DEBUG_DOT, GetPosition, m_LocalPos, m_Parent, ParticleManager(), Math::RandomFloat(), SetPosition() и Vector().

HandleFlickering()

void HandleFlickering ( float time, float timeSlice )

inlineprivate

    {
        if (m_BrightnessPulseAmplitudeMax > 0)
        {
            m_BrightnessPulse += ( Math.RandomFloat(-m_BrightnessPulseSpeed, m_BrightnessPulseSpeed) ) * timeSlice;
            
            if (m_BrightnessPulse < m_BrightnessPulseAmplitudeMin + 1)
                m_BrightnessPulse = m_BrightnessPulseAmplitudeMin + 1;
            
            if (m_BrightnessPulse > m_BrightnessPulseAmplitudeMax + 1)
                m_BrightnessPulse = m_BrightnessPulseAmplitudeMax + 1;
            
        }
        else
        {
            m_BrightnessPulse = 1;
        }
    }

Перекрестные ссылки Math::RandomFloat().

HandleRadiusFadeing()

void HandleRadiusFadeing ( float timeSlice )

inlineprivate

    {
        if ( m_Radius != m_RadiusTarget )
        {
            float radius_difference = m_Radius - m_RadiusTarget;
            
            if (radius_difference > m_RadiusSpeedOfChange*timeSlice)
                radius_difference = m_RadiusSpeedOfChange*timeSlice;
            
            if (radius_difference < -m_RadiusSpeedOfChange*timeSlice)
                radius_difference = -m_RadiusSpeedOfChange*timeSlice;
            
            m_Radius -= radius_difference;
            
            if ( m_Radius > 0  ||  m_RadiusTarget > 0)
            {
                SetRadius(m_Radius);
            }
            else
            {
                Destroy();
                return;
            }
        }
        else
        {
            SetRadius(m_Radius);
        }
    }

Перекрестные ссылки Destroy(), m_Radius и SetRadius().

IsScriptedLight()

override bool IsScriptedLight ( )

inlineprivate

    {
        return true;
    }

OnFrameLightSource()

void OnFrameLightSource ( IEntity other, float timeSlice )

inlineprivate

Override this for custom functionality.

    {
        // ... 
    }

ScriptedLightBase()

void ScriptedLightBase ( )

inlineprivate

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

    {
        m_LifetimeStart = GetGame().GetTime();
        SetEnabled(true);
        SetEventMask(EntityEvent.FRAME);
        SetEventMask(EntityEvent.INIT);
    }

Перекрестные ссылки GetGame() и SetEnabled().

SetBlinkingSpeed()

void SetBlinkingSpeed ( float _speed )

inlineprivate

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

    {
        m_BlinkingSpeed = _speed;
    }

SetBrightnessTo()

void SetBrightnessTo ( float value )

inlineprivate

Sets the brightness of the light.

    {
        m_Brightness = value;
        m_BrightnessTarget = value;
        SetBrightness(m_Brightness * m_BrightnessPulse);
        CorrectLightPulseDuringDaylight();
    }

SetDancingShadowsAmplitude()

void SetDancingShadowsAmplitude ( float max_deviation_in_meters )

inlineprivate

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

    {
        m_DancingShadowsAmplitude = Math.AbsFloat(max_deviation_in_meters);
    }

Перекрестные ссылки Math::AbsFloat().

SetDancingShadowsMovementSpeed()

void SetDancingShadowsMovementSpeed ( float speed_in_meters_per_frame )

inlineprivate

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

    {
        m_DancingShadowsSpeed = Math.AbsFloat(speed_in_meters_per_frame);
    }

Перекрестные ссылки Math::AbsFloat().

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.

    {
        m_OptimizeShadowsRadius = radius_in_m;
    }

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.

    {
        m_FadeOutTime = time_in_s * 1000;
    }

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 )

    {
        m_BrightnessPulseAmplitudeMax = Math.AbsFloat(coef);
        m_BrightnessPulseAmplitudeMin = -Math.AbsFloat(coef);
    }

Перекрестные ссылки Math::AbsFloat().

SetFlickerAmplitudeMax()

void SetFlickerAmplitudeMax ( float coef )

inlineprivate

    {
        m_BrightnessPulseAmplitudeMax = coef;
    }

SetFlickerAmplitudeMin()

void SetFlickerAmplitudeMin ( float coef )

inlineprivate

    {
        m_BrightnessPulseAmplitudeMin = coef;
    }

SetFlickerSpeed()

void SetFlickerSpeed ( float speed )

inlineprivate

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

    {
        m_BrightnessPulseSpeed = speed;
    }

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(...)

    {
        if(GetGame())
            m_LifetimeEnd = GetGame().GetTime() + life_in_s * 1000;
    }

Перекрестные ссылки GetGame().

SetRadiusTo()

void SetRadiusTo ( float value )

inlineprivate

Sets the radius of the light.

    {
        m_Radius = value;
        m_RadiusTarget = value;
        SetRadius(m_Radius);
    }

Перекрестные ссылки m_Radius и SetRadius().

TryShadowOptimization()

void TryShadowOptimization ( )

inlineprivate

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

    {
        if (m_OptimizeShadowsRadius > 0)
        {
            float distance_to_camera = vector.Distance( GetPosition(), GetGame().GetCurrentCameraPosition() );
            
            if (distance_to_camera < m_OptimizeShadowsRadius)
            {
                SetCastShadow(false);
            }
            else
            {
                SetCastShadow(true);
            }
        }
    }

Перекрестные ссылки vector::Distance(), GetGame() и GetPosition.

UpdateLightMode()

void UpdateLightMode ( string slotName )

private

UpdateMode()

void UpdateMode ( )

inlineprivate

    {
        ItemBase item = ItemBase.Cast(m_Parent);
        if (item)
        {
            InventoryLocation il = new InventoryLocation;
            item.GetInventory().GetCurrentInventoryLocation( il );
            string slotName;
            if (il.GetType() == InventoryLocationType.GROUND)
            {
                slotName = "Ground";
            }
            else if (il.GetSlot() != -1)
            {
                slotName = InventorySlots.GetSlotName(il.GetSlot());
            }
            UpdateLightMode(slotName);          
        }
    }

Перекрестные ссылки InventorySlots::GetSlotName(), m_Parent и slotName.

Поля

m_BlinkingSpeed

float m_BlinkingSpeed

private

m_Brightness

float m_Brightness

private

m_BrightnessPulse

float m_BrightnessPulse

private

m_BrightnessPulseAmplitudeMax

float m_BrightnessPulseAmplitudeMax

private

m_BrightnessPulseAmplitudeMin

float m_BrightnessPulseAmplitudeMin

private

m_BrightnessPulseSpeed

float m_BrightnessPulseSpeed

private

m_BrightnessSpeedOfChange

float m_BrightnessSpeedOfChange = 1

private

m_BrightnessTarget

float m_BrightnessTarget

private

m_DancingShadowsAmplitude

float m_DancingShadowsAmplitude

private

m_DancingShadowsLocalPos

vector m_DancingShadowsLocalPos

private

m_DancingShadowsSpeed

float m_DancingShadowsSpeed

private

m_DeleteTimer

ref Timer m_DeleteTimer

private

m_FadeInTime

float m_FadeInTime = -1

private

m_FadeOutTime

float m_FadeOutTime = -1

private

m_IsDebugEnabled

bool m_IsDebugEnabled = false

private

m_LifetimeEnd

float m_LifetimeEnd = -1

private

m_LifetimeStart

float m_LifetimeStart

private

m_LocalOri

vector m_LocalOri

private

m_LocalPos

vector m_LocalPos

private

m_NightTimeOnlyLights

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

staticprivate

m_OptimizeShadowsRadius

float m_OptimizeShadowsRadius = 0

private

m_Parent

Object m_Parent

private

m_Radius

float m_Radius

private

m_RadiusSpeedOfChange

float m_RadiusSpeedOfChange = 1

private

m_RadiusTarget

float m_RadiusTarget

private

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/4_World/Entities/ScriptedLightBase.c