CombinationLock.c File Reference

Enumerations
enum	LockAction {   NONE , DIAL_NUMBER_CHANED , DIAL_INDEX_CHANGED , LOCKED ,   UNLOCKED , COUNT }

Functions
void	CombinationLock ()
protected void	SetBaseLockValues ()
override void	EEInit ()
void	SetInitialized ()
override bool	IsInitialized ()
override void	OnItemLocationChanged (EntityAI old_owner, EntityAI new_owner)
override void	OnStoreSave (ParamsWriteContext ctx)
override bool	OnStoreLoad (ParamsReadContext ctx, int version)
override void	AfterStoreLoad ()
void	Synchronize ()
void	ResetActionVar ()
override void	OnVariablesSynchronized ()
void	SetCombination (int combination)
void	SetCombinationLocked (int combination)
int	GetCombination ()
int	GetLockDigits ()
void	DialNextNumber ()
int	GetDialIndex ()
void	SetNextDial ()
void	LockServer (EntityAI parent, bool ignore_combination=false)
void	UnlockServer (EntityAI player, EntityAI parent)
void	ShuffleLock ()
bool	IsLocked ()
void	CheckLockedStateServer ()
bool	IsLockedOnGate ()
bool	IsLockAttached ()
void	DestroyLock ()
void	UpdateVisuals ()
void	UpdateSound ()
protected void	ShowItem ()
protected void	HideItem ()
protected void	ShowAttached ()
protected void	HideAttached ()
protected void	SoundLockOpen ()
protected void	SoundLockClose ()
void	SoundLockChangeNumber ()
void	SoundLockChangeDial ()
override void	SetActions ()

Variables
enum LockAction	m_LockDigits
int	m_Combination
int	m_CombinationLocked
int	m_DialIndex
protected bool	m_IsLocked
protected LockAction	m_LockActionPerformed = LockAction.NONE
protected bool	m_IsInitialized
const string	SOUND_LOCK_OPEN = "combinationlock_open_SoundSet"
const string	SOUND_LOCK_CLOSE = "combinationlock_close_SoundSet"
const string	SOUND_LOCK_CHANGE_NUMBER = "combinationlock_changenumber_SoundSet"
const string	SOUND_LOCK_CHANGE_DIAL = "combinationlock_changedial_SoundSet"
protected EffectSound	m_Sound

Enumeration Type Documentation

LockAction

enum LockAction

Enumerator
NONE
DIAL_NUMBER_CHANED
DIAL_INDEX_CHANGED
LOCKED
UNLOCKED
COUNT

Function Documentation

AfterStoreLoad()

override void AfterStoreLoad

(

)

References GetGame(), LockServer(), and Synchronize().

CheckLockedStateServer()

void CheckLockedStateServer

(

)

References m_Combination, m_CombinationLocked, and m_IsLocked.

Referenced by DialNextNumber(), LockServer(), and UnlockServer().

CombinationLock()

void CombinationLock

(

)

References m_LockDigits, Math::Pow(), and CombinationLock::SetBaseLockValues().

DestroyLock()

void DestroyLock

(

)

References GetGame(), and CGame::ObjectDelete().

DialNextNumber()

void DialNextNumber

(

)

References CheckLockedStateServer(), string::Get(), string::Length(), m_Combination, m_DialIndex, m_LockActionPerformed, m_LockDigits, SetCombination(), Synchronize(), and string::ToInt().

EEInit()

override void EEInit

(

)

References CALL_CATEGORY_GAMEPLAY, ScriptCallQueue::CallLater(), CGame::GetCallQueue(), GetGame(), SetInitialized(), and UpdateVisuals().

GetCombination()

int GetCombination

(

)

References m_Combination.

GetDialIndex()

int GetDialIndex

(

)

References m_DialIndex.

GetLockDigits()

int GetLockDigits

(

)

References m_LockDigits.

HideAttached()

protected void HideAttached

(

)

Referenced by UpdateVisuals().

HideItem()

protected void HideItem

(

)

Referenced by UpdateVisuals().

IsInitialized()

override bool IsInitialized

(

)

References m_IsInitialized.

Referenced by ItemBase::EEItemAttached(), OnItemLocationChanged(), OnVariablesSynchronized(), GeyserTrigger::OnVariablesSynchronized(), and ItemBase::OnWorkStart().

IsLockAttached()

bool IsLockAttached

(

)

Referenced by LockServer(), and UnlockServer().

IsLocked()

bool IsLocked

(

)

References m_IsLocked.

IsLockedOnGate()

bool IsLockedOnGate

(

)

References IsLocked().

Referenced by UpdateVisuals().

LockServer()

void LockServer	(	EntityAI	parent,
		bool	ignore_combination = false
	)

References bsbDebugPrint(), CheckLockedStateServer(), InventoryLocation::GetSlot(), LogManager::IsBaseBuildingLogEnable(), IsLockAttached(), m_Combination, m_CombinationLocked, m_LockActionPerformed, SetCombinationLocked(), SetTakeable(), ShuffleLock(), and Synchronize().

Referenced by AfterStoreLoad(), and OnItemLocationChanged().

OnItemLocationChanged()

override void OnItemLocationChanged	(	EntityAI	old_owner,
		EntityAI	new_owner
	)

References GetGame(), IsInitialized(), and LockServer().

OnStoreLoad()

override bool OnStoreLoad	(	ParamsReadContext	ctx,
		int	version
	)

References m_Combination, m_CombinationLocked, and Serializer::Read().

OnStoreSave()

override void OnStoreSave

(

ParamsWriteContext

ctx

)

References m_Combination, m_CombinationLocked, and Serializer::Write().

OnVariablesSynchronized()

override void OnVariablesSynchronized

(

)

References bsbDebugPrint(), LogManager::IsBaseBuildingLogEnable(), m_Combination, m_CombinationLocked, m_LockActionPerformed, UpdateSound(), and UpdateVisuals().

ResetActionVar()

void ResetActionVar

(

)

References m_LockActionPerformed.

Referenced by Synchronize().

SetActions()

override void SetActions

(

)

References ActionDialCombinationLock(), ActionDialCombinationLockOnTarget(), and AddAction().

SetBaseLockValues()

protected void SetBaseLockValues

(

)

References m_Combination, m_CombinationLocked, m_IsLocked, and m_LockDigits.

SetCombination()

void SetCombination

(

int

combination

)

References m_Combination.

Referenced by DialNextNumber(), and ShuffleLock().

SetCombinationLocked()

void SetCombinationLocked

(

int

combination

)

References m_CombinationLocked.

Referenced by LockServer().

SetInitialized()

void SetInitialized

(

)

References m_IsInitialized.

Referenced by EEInit().

SetNextDial()

void SetNextDial

(

)

References m_DialIndex, m_LockActionPerformed, m_LockDigits, and Synchronize().

ShowAttached()

protected void ShowAttached

(

)

Referenced by UpdateVisuals().

ShowItem()

protected void ShowItem

(

)

Referenced by UpdateVisuals().

ShuffleLock()

void ShuffleLock

(

)

References string::Get(), string::Length(), m_Combination, m_LockDigits, Math::RandomInt(), SetCombination(), and string::ToInt().

Referenced by LockServer().

SoundLockChangeDial()

void SoundLockChangeDial

(

)

References m_Sound, and SOUND_LOCK_CHANGE_DIAL.

Referenced by UpdateSound().

SoundLockChangeNumber()

void SoundLockChangeNumber

(

)

References m_Sound, and SOUND_LOCK_CHANGE_NUMBER.

Referenced by UpdateSound().

SoundLockClose()

protected void SoundLockClose

(

)

References m_Sound, and SOUND_LOCK_CLOSE.

Referenced by UpdateSound().

SoundLockOpen()

protected void SoundLockOpen

(

)

References m_Sound, and SOUND_LOCK_OPEN.

Referenced by UpdateSound().

Synchronize()

void Synchronize

(

)

References bsbDebugPrint(), CALL_CATEGORY_SYSTEM, ScriptCallQueue::CallLater(), CGame::GetCallQueue(), GetGame(), LogManager::IsBaseBuildingLogEnable(), m_Combination, m_CombinationLocked, ResetActionVar(), and UpdateVisuals().

Referenced by AfterStoreLoad(), CheckValue(), DialNextNumber(), Car::EEItemAttached(), Car::EEItemDetached(), Weapon::FillChamber(), Weapon::FillInnerMagazine(), Heating(), LockServer(), RefreshAudioVisualsOnClient(), RemoveAudioVisualsOnClient(), SetFireState(), SetNextDial(), SetOvenState(), SetStoneCircleState(), Weapon::SpawnAttachedMagazine(), StartFire(), StopFire(), and UnlockServer().

UnlockServer()

void UnlockServer	(	EntityAI	player,
		EntityAI	parent
	)

References bsbDebugPrint(), CheckLockedStateServer(), GetGame(), InventoryLocation::GetSlot(), LogManager::IsBaseBuildingLogEnable(), IsLockAttached(), EntityAI::LocalDropEntity(), m_Combination, m_CombinationLocked, m_LockActionPerformed, EntityAI::ServerDropEntity(), SetPosition(), SetTakeable(), and Synchronize().

UpdateSound()

void UpdateSound

(

)

References m_LockActionPerformed, SoundLockChangeDial(), SoundLockChangeNumber(), SoundLockClose(), and SoundLockOpen().

Referenced by OnVariablesSynchronized().

UpdateVisuals()

void UpdateVisuals

(

)

References CALL_CATEGORY_GAMEPLAY, ScriptCallQueue::CallLater(), CGame::GetCallQueue(), GetGame(), HideAttached(), HideItem(), IsLockedOnGate(), ShowAttached(), and ShowItem().

Variable Documentation

m_Combination

int m_Combination

Referenced by CheckLockedStateServer(), DialNextNumber(), GetCombination(), LockServer(), OnStoreLoad(), OnStoreSave(), OnVariablesSynchronized(), SetBaseLockValues(), CombinationLock::SetBaseLockValues(), SetCombination(), ShuffleLock(), Synchronize(), and UnlockServer().

m_CombinationLocked

int m_CombinationLocked

Referenced by CheckLockedStateServer(), LockServer(), OnStoreLoad(), OnStoreSave(), OnVariablesSynchronized(), SetBaseLockValues(), CombinationLock::SetBaseLockValues(), SetCombinationLocked(), Synchronize(), and UnlockServer().

m_DialIndex

int m_DialIndex

Referenced by DialNextNumber(), GetDialIndex(), and SetNextDial().

m_IsInitialized

protected bool m_IsInitialized

Referenced by IsInitialized(), and SetInitialized().

m_IsLocked

protected bool m_IsLocked

m_LockActionPerformed

protected LockAction m_LockActionPerformed = LockAction.NONE

Referenced by DialNextNumber(), LockServer(), OnVariablesSynchronized(), ResetActionVar(), SetNextDial(), UnlockServer(), and UpdateSound().

m_LockDigits

enum LockAction m_LockDigits

Referenced by CombinationLock(), DialNextNumber(), GetLockDigits(), SetBaseLockValues(), CombinationLock::SetBaseLockValues(), SetNextDial(), and ShuffleLock().

m_Sound

protected EffectSound m_Sound

SOUND_LOCK_CHANGE_DIAL

const string SOUND_LOCK_CHANGE_DIAL = "combinationlock_changedial_SoundSet"

Referenced by SoundLockChangeDial().

SOUND_LOCK_CHANGE_NUMBER

const string SOUND_LOCK_CHANGE_NUMBER = "combinationlock_changenumber_SoundSet"

Referenced by SoundLockChangeNumber().

SOUND_LOCK_CLOSE

const string SOUND_LOCK_CLOSE = "combinationlock_close_SoundSet"

Referenced by SoundLockClose().

SOUND_LOCK_OPEN

const string SOUND_LOCK_OPEN = "combinationlock_open_SoundSet"

Referenced by SoundLockOpen().