SCR_BaseInteractiveLightComponent Interface Reference

Inheritance diagram for SCR_BaseInteractiveLightComponent:

Public Member Functions
bool	GetInitialState ()
bool	IsOn ()
void	ToggleLight (bool turnOn, bool skipTransition=false, bool playSound=true)
override void	EOnVisible (IEntity owner, int frameNumber)
override bool	RplSave (ScriptBitWriter writer)
override bool	RplLoad (ScriptBitReader reader)
override void	OnPostInit (IEntity owner)
void	RemoveLights ()
override void	OnDelete (IEntity owner)
Public Member Functions inherited from SCR_BaseLightComponent
LightEntity	CreateLight (SCR_BaseLightData lightData, vector position, vector direction, float emissivity)

Protected Member Functions
void	TurnOn (notnull SCR_BaseInteractiveLightComponentClass componentData, bool skipTransition, bool playSound)
void	TurnOff (notnull SCR_BaseInteractiveLightComponentClass componentData, bool playSound)

Protected Attributes
ref array< LightEntity >	m_aLights
ParametricMaterialInstanceComponent	m_EmissiveMaterialComponent
float	m_fCurLV
float	m_fCurEM
float	m_fLightEmisivityStep
bool	m_bIsOn

Static Protected Attributes
const static float	MATERIAL_EMISSIVITY_STEP = 0.1
const static int	MATERIAL_EMISSIVITY_ON = 30
const static float	LIGHT_EMISSIVITY_START = 0.1
const static int	MATERIAL_EMISSIVITY_START = 1
const static int	LIGHT_EMISSIVITY_OFF = 0
const static int	UPDATE_LIGHT_TIME = 100

Member Function Documentation

EOnVisible()

override void SCR_BaseInteractiveLightComponent.EOnVisible	(	IEntity	owner,
		int	frameNumber
	)

Implemented in SCR_FireplaceComponent, and SCR_FlareEffectComponent.

GetInitialState()

bool SCR_BaseInteractiveLightComponent.GetInitialState

(

)

Returns

IsOn()

bool SCR_BaseInteractiveLightComponent.IsOn

(

)

Returns

OnDelete()

override void SCR_BaseInteractiveLightComponent.OnDelete

(

IEntity

owner

)

Implemented in SCR_FireplaceComponent, SCR_FlareEffectComponent, and SCR_LampComponent.

OnPostInit()

override void SCR_BaseInteractiveLightComponent.OnPostInit

(

IEntity

owner

)

Implemented in SCR_FireplaceComponent, and SCR_FlareEffectComponent.

RemoveLights()

void SCR_BaseInteractiveLightComponent.RemoveLights

(

)

RplLoad()

override bool SCR_BaseInteractiveLightComponent.RplLoad

(

ScriptBitReader

reader

)

Implemented in SCR_FireplaceComponent, and SCR_LampComponent.

RplSave()

override bool SCR_BaseInteractiveLightComponent.RplSave

(

ScriptBitWriter

writer

)

ToggleLight()

void SCR_BaseInteractiveLightComponent.ToggleLight	(	bool	turnOn,
		bool	skipTransition = false,
		bool	playSound = true
	)

Parameters

[in]	turnOn
[in]	skipTransition
[in]	playSound

Implemented in SCR_FireplaceComponent, SCR_FlareEffectComponent, and SCR_LampComponent.

TurnOff()

void SCR_BaseInteractiveLightComponent.TurnOff ( notnull SCR_BaseInteractiveLightComponentClass  componentData, bool  playSound  )

protected

TurnOn()

void SCR_BaseInteractiveLightComponent.TurnOn ( notnull SCR_BaseInteractiveLightComponentClass  componentData, bool  skipTransition, bool  playSound  )

protected

Member Data Documentation

LIGHT_EMISSIVITY_OFF

const static int SCR_BaseInteractiveLightComponent.LIGHT_EMISSIVITY_OFF = 0

staticprotected

LIGHT_EMISSIVITY_START

const static float SCR_BaseInteractiveLightComponent.LIGHT_EMISSIVITY_START = 0.1

staticprotected

m_aLights

ref array<LightEntity> SCR_BaseInteractiveLightComponent.m_aLights

protected

m_bIsOn

bool SCR_BaseInteractiveLightComponent.m_bIsOn

protected

m_EmissiveMaterialComponent

ParametricMaterialInstanceComponent SCR_BaseInteractiveLightComponent.m_EmissiveMaterialComponent

protected

m_fCurEM

float SCR_BaseInteractiveLightComponent.m_fCurEM

protected

m_fCurLV

float SCR_BaseInteractiveLightComponent.m_fCurLV

protected

m_fLightEmisivityStep

float SCR_BaseInteractiveLightComponent.m_fLightEmisivityStep

protected

MATERIAL_EMISSIVITY_ON

const static int SCR_BaseInteractiveLightComponent.MATERIAL_EMISSIVITY_ON = 30

staticprotected

MATERIAL_EMISSIVITY_START

const static int SCR_BaseInteractiveLightComponent.MATERIAL_EMISSIVITY_START = 1

staticprotected

MATERIAL_EMISSIVITY_STEP

const static float SCR_BaseInteractiveLightComponent.MATERIAL_EMISSIVITY_STEP = 0.1

staticprotected

UPDATE_LIGHT_TIME

const static int SCR_BaseInteractiveLightComponent.UPDATE_LIGHT_TIME = 100

staticprotected

---

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

• Game/Lights/SCR_BaseInteractiveLightComponent.c