SCR_VehicleSpawnProtectionComponent Interface Reference

Inheritance diagram for SCR_VehicleSpawnProtectionComponent:

Public Member Functions
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)
void	ReleaseProtection ()
void	SetProtectionTime (int protectionTime)
void	SetVehicleOwner (int playerID)
void	SetProtectOnlyDriverSeat (bool onlyDriverSeat)
void	SetReasonText (string text)
int	GetVehicleOwner ()
bool	IsProtected (notnull IEntity playerEntering, notnull BaseCompartmentSlot compartmentSlot)
LocalizedString	GetReasonText (IEntity user)
void	RemoveEventHandlers ()
Public Member Functions inherited from SCR_BaseLockComponent
void	SetLocked (bool locked)
LocalizedString	GetCannotPerformReason (IEntity user)
bool	IsLocked (IEntity user, BaseCompartmentSlot compartmentSlot)

Public Attributes
bool	m_bOnlyDriverSeat = true

Protected Member Functions
void	OnPlayerDisconected (int playerID)
void	OnPlayerDisconnected (int playerID)

Protected Attributes
int	m_iTimeOfProtection
string	m_sReasonText
Protected Attributes inherited from SCR_BaseLockComponent
SCR_VehicleSpawnProtectionComponent	m_pVehicleSpawnProtection
bool	m_bIsLocked

Static Protected Attributes
static const int	NO_OWNER = -1
static const int	NO_TIME_LIMIT = 0

Member Function Documentation

EOnInit()

override void SCR_VehicleSpawnProtectionComponent.EOnInit

(

IEntity

owner

)

Implements SCR_BaseLockComponent.

GetReasonText()

LocalizedString SCR_VehicleSpawnProtectionComponent.GetReasonText

(

IEntity

user

)

Parameters

[in]

user

Returns

GetVehicleOwner()

int SCR_VehicleSpawnProtectionComponent.GetVehicleOwner

(

)

Returns

IsProtected()

bool SCR_VehicleSpawnProtectionComponent.IsProtected	(	notnull IEntity	playerEntering,
		notnull BaseCompartmentSlot	compartmentSlot )

Parameters

[in]	playerEntering
[in]	compartmentSlot

Returns

OnPlayerDisconected()

void SCR_VehicleSpawnProtectionComponent.OnPlayerDisconected ( int playerID )

protected

OnPlayerDisconnected()

void SCR_VehicleSpawnProtectionComponent.OnPlayerDisconnected ( int playerID )

protected

OnPostInit()

override void SCR_VehicleSpawnProtectionComponent.OnPostInit

(

IEntity

owner

)

Implements SCR_BaseLockComponent.

ReleaseProtection()

void SCR_VehicleSpawnProtectionComponent.ReleaseProtection

(

)

RemoveEventHandlers()

void SCR_VehicleSpawnProtectionComponent.RemoveEventHandlers

(

)

SetProtectionTime()

void SCR_VehicleSpawnProtectionComponent.SetProtectionTime

(

int

protectionTime

)

Parameters

[in]

protectionTime

SetProtectOnlyDriverSeat()

void SCR_VehicleSpawnProtectionComponent.SetProtectOnlyDriverSeat

(

bool

onlyDriverSeat

)

Parameters

[in]

onlyDriverSeat

SetReasonText()

void SCR_VehicleSpawnProtectionComponent.SetReasonText

(

string

text

)

Parameters

[in]

text

SetVehicleOwner()

void SCR_VehicleSpawnProtectionComponent.SetVehicleOwner

(

int

playerID

)

Parameters

[in]

playerID

Member Data Documentation

m_bOnlyDriverSeat

bool SCR_VehicleSpawnProtectionComponent.m_bOnlyDriverSeat = true

m_iTimeOfProtection

int SCR_VehicleSpawnProtectionComponent.m_iTimeOfProtection

protected

m_sReasonText

string SCR_VehicleSpawnProtectionComponent.m_sReasonText

protected

NO_OWNER

const int SCR_VehicleSpawnProtectionComponent.NO_OWNER = -1

staticprotected

NO_TIME_LIMIT

const int SCR_VehicleSpawnProtectionComponent.NO_TIME_LIMIT = 0

staticprotected

---

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

• Game/Campaign/SCR_VehicleSpawnProtectionComponent.c