Collaboration diagram for SpotLightBase:

[legend]

Private Member Functions
void	CarLightBase ()

void	AggregateLight ()

void	SegregateLight ()

void	FlashlightLight ()

void	SetIntensity (float coef, float time)

void	HeadtorchLight ()

void	SetColorToWhite ()

void	SetColorToRed ()

void	SetIntensity (float coef, float time)

void	PerformVisibilityCheck (EntityAI owner)

void	PistollightLight ()

void	SetIntensity (float coef, float time)

override void	UpdateLightMode (string slotName)

void	SpotlightLight ()

void	UniversallightLight ()

void	SetIntensity (float coef, float time)

override void	UpdateLightMode (string slotName)

Private Attributes
float	m_SegregatedBrightness = 20

float	m_SegregatedRadius = 66

float	m_SegregatedAngle = 90

vector	m_SegregatedColorRGB = Vector(1.0, 0.8, 0.6)

float	m_AggregatedBrightness = 30

float	m_AggregatedRadius = 100

float	m_AggregatedAngle = 100

vector	m_AggregatedColorRGB = Vector(1.0, 0.8, 0.6)

Static Private Attributes
static float	m_DefaultBrightness = 4

static float	m_DefaultRadius = 25

static float	m_DefaultAngle = 100

Detailed Description

Definition at line 1 of file CarLightBase.c.

Member Function Documentation

◆ AggregateLight()

void SpotLightBase::AggregateLight ( )

inlineprivate

Definition at line 28 of file CarLightBase.c.

  {
    SetRadiusTo(m_AggregatedRadius);
    SetSpotLightAngle(m_AggregatedAngle);
    SetBrightnessTo(m_AggregatedBrightness);
    SetAmbientColor(m_AggregatedColorRGB[0], m_AggregatedColorRGB[1], m_AggregatedColorRGB[2]);
    SetDiffuseColor(m_AggregatedColorRGB[0], m_AggregatedColorRGB[1], m_AggregatedColorRGB[2]);
    SetFlareVisible(false);
  }

◆ CarLightBase()

void SpotLightBase::CarLightBase ( )

inlineprivate

Definition at line 18 of file CarLightBase.c.

  {
    SetVisibleDuringDaylight(true);
    SetCastShadow(true);
    SetFlareVisible(true);
    FadeIn(0.3);
    SetFadeOutTime(0.25);
 
  }

◆ FlashlightLight()

void SpotLightBase::FlashlightLight ( )

inlineprivate

Definition at line 6 of file FlashlightLight.c.

  {
    SetVisibleDuringDaylight(true);
    SetRadiusTo(m_DefaultRadius);
    SetSpotLightAngle(110);
    SetCastShadow(true);
    EnableSpecular(true);
    SetBrightnessTo(m_DefaultBrightness);
    SetFadeOutTime(0.15);
    SetAmbientColor(0.9, 0.85, 0.75);
    SetDiffuseColor(0.9, 0.85, 0.75);
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ HeadtorchLight()

void SpotLightBase::HeadtorchLight ( )

inlineprivate

Definition at line 6 of file HeadtorchLight.c.

  {
    SetVisibleDuringDaylight(true);
    SetRadiusTo(m_DefaultRadius);
    SetSpotLightAngle(95);
    SetCastShadow(true);
    FadeIn(0.06);
    SetBrightnessTo(m_DefaultBrightness);
    SetAmbientColor(0.92, 0.85, 0.58);
    SetDiffuseColor(0.92, 0.85, 0.58);
    SetFadeOutTime(0.1);
    //SetDisableShadowsWithinRadius(0.25); // Idea for optimization: Uncomment this to disable shadows from Headtorch while it's on player's head during 1P view.
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ PerformVisibilityCheck()

void SpotLightBase::PerformVisibilityCheck ( EntityAI owner )

inlineprivate

Definition at line 38 of file HeadtorchLight.c.

  {
    if (!owner.IsFlagSet(EntityFlags.VISIBLE) && IsEnabled())
      SetEnabled(false);
    else if (owner.IsFlagSet(EntityFlags.VISIBLE) && !IsEnabled())
      SetEnabled(true);
  }

References SetEnabled().

◆ PistollightLight()

void SpotLightBase::PistollightLight ( )

inlineprivate

Definition at line 8 of file PistollightLight.c.

  {
    SetVisibleDuringDaylight(true);
    SetRadiusTo(m_DefaultRadius);
    SetSpotLightAngle(m_DefaultAngle);
    SetCastShadow(true);
    SetBrightnessTo(m_DefaultBrightness);
    SetFadeOutTime(0.05);
    SetAmbientColor(0.92, 0.88, 0.82);
    SetDiffuseColor(0.92, 0.88, 0.82);
    SetDisableShadowsWithinRadius(1.2);
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ SegregateLight()

void SpotLightBase::SegregateLight ( )

inlineprivate

Definition at line 38 of file CarLightBase.c.

  {
    SetRadiusTo(m_SegregatedRadius);
    SetSpotLightAngle(m_SegregatedAngle);
    SetBrightnessTo(m_SegregatedBrightness);
    SetAmbientColor(m_SegregatedColorRGB[0], m_SegregatedColorRGB[1], m_SegregatedColorRGB[2]);
    SetDiffuseColor(m_SegregatedColorRGB[0], m_SegregatedColorRGB[1], m_SegregatedColorRGB[2]);
    SetFlareVisible(true);
  }

◆ SetColorToRed()

void SpotLightBase::SetColorToRed ( )

inlineprivate

Definition at line 26 of file HeadtorchLight.c.

  {
    SetAmbientColor(1.0, 0.2, 0.2);
    SetDiffuseColor(1.0, 0.2, 0.2);
  }

◆ SetColorToWhite()

void SpotLightBase::SetColorToWhite ( )

inlineprivate

Definition at line 20 of file HeadtorchLight.c.

  {
    SetAmbientColor(0.92, 0.85, 0.86);
    SetDiffuseColor(0.92, 0.85, 0.86);
  }

◆ SetIntensity() [1/4]

void SpotLightBase::SetIntensity	(	float	coef,
		float	time )

inlineprivate

Definition at line 19 of file FlashlightLight.c.

  {
    FadeBrightnessTo(m_DefaultBrightness * coef, time);
  }

References m_DefaultBrightness.

◆ SetIntensity() [2/4]

void SpotLightBase::SetIntensity	(	float	coef,
		float	time )

inlineprivate

Definition at line 32 of file HeadtorchLight.c.

  {
    FadeBrightnessTo(m_DefaultBrightness * coef, time);
    FadeRadiusTo(m_DefaultRadius * coef, time);
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ SetIntensity() [3/4]

void SpotLightBase::SetIntensity	(	float	coef,
		float	time )

inlineprivate

Definition at line 21 of file PistollightLight.c.

  {
    FadeBrightnessTo(m_DefaultBrightness * coef, time);
    FadeRadiusTo(m_DefaultRadius * coef, time);
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ SetIntensity() [4/4]

void SpotLightBase::SetIntensity	(	float	coef,
		float	time )

inlineprivate

Definition at line 20 of file UniversallightLight.c.

  {
    FadeBrightnessTo(m_DefaultBrightness * coef, time);
    FadeRadiusTo(m_DefaultRadius * coef, time);
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ SpotlightLight()

void SpotLightBase::SpotlightLight ( )

inlineprivate

Definition at line 3 of file SpotlightLight.c.

  {
    SetVisibleDuringDaylight(true);
    SetRadiusTo(60);
    SetSpotLightAngle(140);
    SetCastShadow(true);
    SetBrightnessTo(20.0);
    SetFadeOutTime(0.3);
    FadeIn(0.2);
    SetAmbientColor(0.8, 0.9, 1.0);
    SetDiffuseColor(0.8, 0.9, 1.0);
  }

◆ UniversallightLight()

void SpotLightBase::UniversallightLight ( )

inlineprivate

Definition at line 7 of file UniversallightLight.c.

  {
    SetVisibleDuringDaylight(true);
    SetRadiusTo(m_DefaultRadius);
    SetSpotLightAngle(m_DefaultAngle);
    SetCastShadow(true);
    SetBrightnessTo(m_DefaultBrightness);
    SetFadeOutTime(0.15);
    SetAmbientColor(0.95, 0.88, 0.8);
    SetDiffuseColor(0.95, 0.88, 0.8);
    SetDisableShadowsWithinRadius(1.2);
  }

References m_DefaultBrightness, and m_DefaultRadius.

◆ UpdateLightMode() [1/2]

override void SpotLightBase::UpdateLightMode ( string slotName )

inlineprivate

Definition at line 27 of file PistollightLight.c.

  {
    switch (slotName)
    {
    case "weaponFlashlight":
      SetSpotLightAngle(m_DefaultAngle / 2);
      SetRadiusTo(m_DefaultRadius * 1.8);
      break;
 
    default:
      SetSpotLightAngle(m_DefaultAngle);
      SetRadiusTo(m_DefaultRadius);
      break;
    }
  }

References m_DefaultRadius, and slotName.

◆ UpdateLightMode() [2/2]

override void SpotLightBase::UpdateLightMode ( string slotName )

inlineprivate

Definition at line 26 of file UniversallightLight.c.

  {
    switch (slotName)
    {
    case "weaponFlashlight":
      SetSpotLightAngle(m_DefaultAngle / 2);
      SetRadiusTo(m_DefaultRadius * 1.8);
      break;
 
    default:
      SetSpotLightAngle(m_DefaultAngle);
      SetRadiusTo(m_DefaultRadius);
      break;
    }
  }

References m_DefaultRadius, and slotName.

Member Data Documentation

◆ m_AggregatedAngle

float SpotLightBase::m_AggregatedAngle = 100

private

Definition at line 15 of file CarLightBase.c.

◆ m_AggregatedBrightness

float SpotLightBase::m_AggregatedBrightness = 30

private

Definition at line 13 of file CarLightBase.c.

◆ m_AggregatedColorRGB

vector SpotLightBase::m_AggregatedColorRGB = Vector(1.0, 0.8, 0.6)

private

Definition at line 16 of file CarLightBase.c.

◆ m_AggregatedRadius

float SpotLightBase::m_AggregatedRadius = 100

private

Definition at line 14 of file CarLightBase.c.

◆ m_DefaultAngle

static float SpotLightBase::m_DefaultAngle = 100

staticprivate

Definition at line 5 of file PistollightLight.c.

◆ m_DefaultBrightness

static float SpotLightBase::m_DefaultBrightness = 4

staticprivate

Definition at line 3 of file FlashlightLight.c.

◆ m_DefaultRadius

static float SpotLightBase::m_DefaultRadius = 25

staticprivate

Definition at line 4 of file FlashlightLight.c.

◆ m_SegregatedAngle

float SpotLightBase::m_SegregatedAngle = 90

private

Definition at line 10 of file CarLightBase.c.

◆ m_SegregatedBrightness

float SpotLightBase::m_SegregatedBrightness = 20

private

Definition at line 8 of file CarLightBase.c.

◆ m_SegregatedColorRGB

vector SpotLightBase::m_SegregatedColorRGB = Vector(1.0, 0.8, 0.6)

private

Definition at line 11 of file CarLightBase.c.

◆ m_SegregatedRadius

float SpotLightBase::m_SegregatedRadius = 66

private

Definition at line 9 of file CarLightBase.c.

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

scripts/4_World/Entities/ScriptedLightBase/SpotLightBase/CarLightBase.c
scripts/4_World/Entities/ScriptedLightBase/SpotLightBase/FlashlightLight.c
scripts/4_World/Entities/ScriptedLightBase/SpotLightBase/HeadtorchLight.c
scripts/4_World/Entities/ScriptedLightBase/SpotLightBase/PistollightLight.c
scripts/4_World/Entities/ScriptedLightBase/SpotLightBase/UniversallightLight.c
scripts/4_World/Entities/ScriptedLightBase/SpotLightBase/SpotlightLight.c

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ AggregateLight()

◆ CarLightBase()

◆ FlashlightLight()

◆ HeadtorchLight()

◆ PerformVisibilityCheck()

◆ PistollightLight()

◆ SegregateLight()

◆ SetColorToRed()

◆ SetColorToWhite()

◆ SetIntensity() [1/4]

◆ SetIntensity() [2/4]

◆ SetIntensity() [3/4]

◆ SetIntensity() [4/4]

◆ SpotlightLight()

◆ UniversallightLight()

◆ UpdateLightMode() [1/2]

◆ UpdateLightMode() [2/2]

Member Data Documentation

◆ m_AggregatedAngle

◆ m_AggregatedBrightness

◆ m_AggregatedColorRGB

◆ m_AggregatedRadius

◆ m_DefaultAngle

◆ m_DefaultBrightness

◆ m_DefaultRadius

◆ m_SegregatedAngle

◆ m_SegregatedBrightness

◆ m_SegregatedColorRGB

◆ m_SegregatedRadius