SCR_FireplaceComponent Interface Reference

Inheritance diagram for SCR_FireplaceComponent:

Public Member Functions
override void	ToggleLight (bool turnOn, bool skipTransition=false, bool playSound=true)
void	TurnOn ()
void	TurnOff ()
override void	OnPostInit (IEntity owner)
override void	EOnVisible (IEntity owner, int frameNumber)
override bool	RplLoad (ScriptBitReader reader)
override void	OnDelete (IEntity owner)
Public Member Functions inherited from SCR_BaseInteractiveLightComponent
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 Attributes
SCR_BaseInteractiveLightComponentClass	m_ComponentData
IEntity	m_DecalEntity
float	m_fTimer
float	m_fCompDataLV
Protected Attributes inherited from SCR_BaseInteractiveLightComponent
ref array< LightEntity >	m_aLights
ParametricMaterialInstanceComponent	m_EmissiveMaterialComponent
float	m_fCurLV
float	m_fCurEM
float	m_fLightEmisivityStep
bool	m_bIsOn

Static Protected Attributes
static const float	FLICKER_STEP = 0.05
static const float	FLICKER_THRESHOLD = 0.35
static const float	FLICKER_FREQUENCY = 1 / 30
Static Protected Attributes inherited from SCR_BaseInteractiveLightComponent
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

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseInteractiveLightComponent
void	TurnOn (notnull SCR_BaseInteractiveLightComponentClass componentData, bool skipTransition, bool playSound)
void	TurnOff (notnull SCR_BaseInteractiveLightComponentClass componentData, bool playSound)

Member Function Documentation

EOnVisible()

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

Implements SCR_BaseInteractiveLightComponent.

OnDelete()

override void SCR_FireplaceComponent.OnDelete

(

IEntity

owner

)

Implements SCR_BaseInteractiveLightComponent.

OnPostInit()

override void SCR_FireplaceComponent.OnPostInit

(

IEntity

owner

)

Implements SCR_BaseInteractiveLightComponent.

RplLoad()

override bool SCR_FireplaceComponent.RplLoad

(

ScriptBitReader

reader

)

Implements SCR_BaseInteractiveLightComponent.

ToggleLight()

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

Parameters

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

Implements SCR_BaseInteractiveLightComponent.

TurnOff()

void SCR_FireplaceComponent.TurnOff

(

)

TurnOn()

void SCR_FireplaceComponent.TurnOn

(

)

Member Data Documentation

FLICKER_FREQUENCY

const float SCR_FireplaceComponent.FLICKER_FREQUENCY = 1 / 30

staticprotected

FLICKER_STEP

const float SCR_FireplaceComponent.FLICKER_STEP = 0.05

staticprotected

FLICKER_THRESHOLD

const float SCR_FireplaceComponent.FLICKER_THRESHOLD = 0.35

staticprotected

m_ComponentData

SCR_BaseInteractiveLightComponentClass SCR_FireplaceComponent.m_ComponentData

protected

m_DecalEntity

IEntity SCR_FireplaceComponent.m_DecalEntity

protected

m_fCompDataLV

float SCR_FireplaceComponent.m_fCompDataLV

protected

m_fTimer

float SCR_FireplaceComponent.m_fTimer

protected

---

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

• Game/Components/SCR_FireplaceComponent.c