SCR_LightSlot Interface Reference

Inheritance diagram for SCR_LightSlot:

Public Member Functions
ScriptInvoker	GetOnLightStateChanged ()
	Get event called when the light is turned on or off.
override void	OnLightStateChanged (bool newState)
override void	OnInit (IEntity owner)
void	PlaySound (bool newState)
Public Member Functions inherited from BaseLightSlot
proto external bool	ShouldTick ()
proto external int	GetLightSide ()
proto external int	GetSurfaceID ()
proto external string	GetParentSurfaceName ()
proto external bool	IsPresence ()
proto external bool	IsLightFunctional ()
proto external IEntity	GetOwner ()
proto external IEntity	GetLightEntity ()
proto external ELightType	GetLightType ()
proto external int	GetLightID ()
proto external void	SetLightFunctional (bool state)
	Set whether the light works or is broken.

Protected Attributes
string	m_sLightOnEventName
string	m_sLightOffEventName
bool	m_bIsActive
SoundComponent	m_SoundComponent
ref ScriptInvoker	m_OnLightStateChanged

Additional Inherited Members
void	OnInit (IEntity owner)
void	OnLightStateChanged (bool newState)

Member Function Documentation

GetOnLightStateChanged()

ScriptInvoker SCR_LightSlot.GetOnLightStateChanged

(

)

Get event called when the light is turned on or off.

Returns

Script invoker (bool)

OnInit()

override void SCR_LightSlot.OnInit

(

IEntity

owner

)

Implements BaseLightSlot.

OnLightStateChanged()

override void SCR_LightSlot.OnLightStateChanged

(

bool

newState

)

Implements BaseLightSlot.

PlaySound()

void SCR_LightSlot.PlaySound

(

bool

newState

)

Parameters

newState

Member Data Documentation

m_bIsActive

bool SCR_LightSlot.m_bIsActive

protected

m_OnLightStateChanged

ref ScriptInvoker SCR_LightSlot.m_OnLightStateChanged

protected

m_sLightOffEventName

string SCR_LightSlot.m_sLightOffEventName

protected

m_sLightOnEventName

string SCR_LightSlot.m_sLightOnEventName

protected

m_SoundComponent

SoundComponent SCR_LightSlot.m_SoundComponent

protected

---

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

• Game/Vehicle/SCR_LightSlot.c