CombinationLock.c File Reference

Go to the source code of this file.

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

Functions
void	CombinationLock ()
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 ()
void	ShowItem ()
void	HideItem ()
void	ShowAttached ()
void	HideAttached ()
void	SoundLockOpen ()
void	SoundLockClose ()
void	SoundLockChangeNumber ()
void	SoundLockChangeDial ()
override void	SetActions ()

Variables
enum LockAction	m_LockDigits
int	m_Combination
int	m_CombinationLocked
int	m_DialIndex
bool	m_IsLocked
LockAction	m_LockActionPerformed = LockAction.NONE
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"
EffectSound	m_Sound

Enumeration Type Documentation

LockAction

enum LockAction

Enumerator
NONE
DIAL_NUMBER_CHANED
DIAL_INDEX_CHANGED
LOCKED
UNLOCKED
COUNT

Definition at line 1 of file CombinationLock.c.

{
  NONE,
  DIAL_NUMBER_CHANED,
  DIAL_INDEX_CHANGED,
  LOCKED,
  UNLOCKED,
 
  COUNT
}

Function Documentation

AfterStoreLoad()

override void AfterStoreLoad ( )

protected

Definition at line 128 of file CombinationLock.c.

  {
    super.AfterStoreLoad();
 
    //Check combination lock
    if (GetGame().IsServer())
    {
      EntityAI parent = GetHierarchyParent();
      if (parent && parent.IsInherited(BaseBuildingBase))
        LockServer(parent, true);
    }
 
    //synchronize
    Synchronize();
  }

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

CheckLockedStateServer()

void CheckLockedStateServer ( )

protected

Definition at line 339 of file CombinationLock.c.

  {
    m_IsLocked = m_Combination != m_CombinationLocked;
  }

References m_Combination, m_CombinationLocked, and m_IsLocked.

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

CombinationLock()

void CombinationLock ( )

protected

Definition at line 33 of file CombinationLock.c.

  {
    SetBaseLockValues();
 
    //synchronized variables
    int combination_length = Math.Pow(10, m_LockDigits);
    RegisterNetSyncVariableBool("m_IsLocked");
    RegisterNetSyncVariableInt("m_Combination", 0, combination_length - 1);
    RegisterNetSyncVariableInt("m_DialIndex", 0, m_LockDigits - 1);
    RegisterNetSyncVariableInt("m_LockActionPerformed", 0, LockAction.COUNT);
  }

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

DestroyLock()

void DestroyLock ( )

protected

Definition at line 366 of file CombinationLock.c.

  {
    GetGame().ObjectDelete(this);
  }

References GetGame().

DialNextNumber()

void DialNextNumber ( )

protected

Definition at line 196 of file CombinationLock.c.

  {
    string combination_text = m_Combination.ToString();
    string dialed_text;
 
    //insert zeros to dials with 0 value
    int length_diff = m_LockDigits - combination_text.Length();
    for (int i = 0; i < length_diff; ++i)
      combination_text = "0" + combination_text;
 
    //assemble the whole combination with increased part
    for (int j = 0; j < combination_text.Length(); ++j)
    {
      if (j == m_DialIndex)
      {
        int next_dialed_number = combination_text.Get(j).ToInt() + 1;
        if (next_dialed_number > 9)
          next_dialed_number = 0;
 
        dialed_text += next_dialed_number.ToString();
      }
      else
        dialed_text += combination_text.Get(j);
    }
 
    //set new number
    SetCombination(dialed_text.ToInt());
    m_LockActionPerformed = LockAction.DIAL_INDEX_CHANGED;
    CheckLockedStateServer();
 
    //synchronize
    Synchronize();
  }

References CheckLockedStateServer(), m_Combination, m_DialIndex, m_LockActionPerformed, m_LockDigits, SetCombination(), and Synchronize().

EEInit()

override void EEInit ( )

protected

Definition at line 54 of file CombinationLock.c.

  {
    super.EEInit();
 
    GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).CallLater(SetInitialized, 1000, false);
    //SetInitialized();
 
    //set visual on init
    UpdateVisuals();
  }

References CALL_CATEGORY_GAMEPLAY, GetGame(), SetInitialized(), and UpdateVisuals().

GetCombination()

int GetCombination ( )

protected

Definition at line 185 of file CombinationLock.c.

  {
    return m_Combination;
  }

References m_Combination.

GetDialIndex()

int GetDialIndex ( )

protected

Definition at line 230 of file CombinationLock.c.

  {
    return m_DialIndex;
  }

References m_DialIndex.

GetLockDigits()

int GetLockDigits ( )

protected

Definition at line 190 of file CombinationLock.c.

  {
    return m_LockDigits;
  }

References m_LockDigits.

HideAttached()

void HideAttached ( )

protected

Definition at line 428 of file CombinationLock.c.

  {
    SetAnimationPhase("Combination_Lock_Attached", 1);
    SetAnimationPhase("Lock_Attached_1", 1);
    SetAnimationPhase("Lock_Attached_2", 1);
  }

Referenced by UpdateVisuals().

HideItem()

void HideItem ( )

protected

Definition at line 414 of file CombinationLock.c.

  {
    SetAnimationPhase("Combination_Lock_Item", 1);
    SetAnimationPhase("Lock_Item_1", 1);
    SetAnimationPhase("Lock_Item_2", 1);
  }

Referenced by UpdateVisuals().

IsInitialized()

override bool IsInitialized ( )

protected

Definition at line 70 of file CombinationLock.c.

  {
    return m_IsInitialized;
  }

References m_IsInitialized.

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

IsLockAttached()

bool IsLockAttached ( )

protected

Definition at line 356 of file CombinationLock.c.

  {
    Fence fence = Fence.Cast(GetHierarchyParent());
    if (fence)
      return true;
 
    return false;
  }

Referenced by LockServer(), and UnlockServer().

IsLocked()

bool IsLocked ( )

protected

Definition at line 334 of file CombinationLock.c.

  {
    return m_IsLocked;
  }

References m_IsLocked.

IsLockedOnGate()

bool IsLockedOnGate ( )

protected

Definition at line 344 of file CombinationLock.c.

  {
    Fence fence = Fence.Cast(GetHierarchyParent());
    if (fence)
    {
      if (IsLocked())
        return true;
    }
 
    return false;
  }

References IsLocked().

Referenced by UpdateVisuals().

LockServer()

void LockServer ( EntityAI parent, bool ignore_combination = false )

protected

Definition at line 254 of file CombinationLock.c.

  {
    if (LogManager.IsBaseBuildingLogEnable()) bsbDebugPrint("[bsb] CombinationLock.LockServer " + " m_Combination=" + m_Combination + " m_CombinationLocked=" + m_CombinationLocked);
    if (IsLockAttached())
    {
      if (!ignore_combination)
      {
        SetCombinationLocked(m_Combination);
 
        //set slot lock
        InventoryLocation inventory_location = new InventoryLocation;
        GetInventory().GetCurrentInventoryLocation(inventory_location);
        parent.GetInventory().SetSlotLock(inventory_location.GetSlot(), true);
 
        m_LockActionPerformed = LockAction.LOCKED;
      }
      ShuffleLock();
      SetTakeable(false);
      CheckLockedStateServer();
      //synchronize
      Synchronize();
    }
 
    //reset performed action
    //m_LockActionPerformed = LockAction.NONE;
  }

References bsbDebugPrint(), CheckLockedStateServer(), 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 )

protected

Definition at line 75 of file CombinationLock.c.

  {
    super.OnItemLocationChanged(old_owner, new_owner);
 
    //Check combination lock
    if (GetGame().IsServer())
    {
      if (IsInitialized() && new_owner && new_owner.IsInherited(BaseBuildingBase))
        LockServer(new_owner);
    }
  }

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

OnStoreLoad()

override bool OnStoreLoad ( ParamsReadContext ctx, int version )

protected

Definition at line 97 of file CombinationLock.c.

  {
    if (!super.OnStoreLoad(ctx, version))
      return false;
 
    //--- Combination Lock data ---
    //combination
    if (!ctx.Read(m_Combination))
    {
      m_Combination = 0;
      return false;
    }
 
    //combination locked
    if (!ctx.Read(m_CombinationLocked))
    {
      m_CombinationLocked = 0;
      return false;
    }
 
    //is lock attached
    if (version < 105) //removed in 105
    {
      bool is_lock_attached;
      if (!ctx.Read(is_lock_attached))
        return false;
    }
 
    return true;
  }

References m_Combination, and m_CombinationLocked.

OnStoreSave()

override void OnStoreSave ( ParamsWriteContext ctx )

protected

Definition at line 88 of file CombinationLock.c.

  {
    super.OnStoreSave(ctx);
 
    //write data
    ctx.Write(m_Combination);
    ctx.Write(m_CombinationLocked);
  }

References m_Combination, and m_CombinationLocked.

OnVariablesSynchronized()

override void OnVariablesSynchronized ( )

protected

Definition at line 162 of file CombinationLock.c.

  {
    super.OnVariablesSynchronized();
    //update visuals (client)
    UpdateVisuals();
 
    //update sound (client)
    if (m_LockActionPerformed)
      UpdateSound();
 
    if (LogManager.IsBaseBuildingLogEnable()) bsbDebugPrint("[bsb] CombinationLock.OnVariablesSynchronized " + " m_Combination=" + m_Combination + " m_CombinationLocked=" + m_CombinationLocked);
  }

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

ResetActionVar()

void ResetActionVar ( )

protected

Definition at line 157 of file CombinationLock.c.

  {
    m_LockActionPerformed = LockAction.NONE;
  }

References m_LockActionPerformed.

Referenced by Synchronize().

SetActions()

override void SetActions ( )

protected

Definition at line 459 of file CombinationLock.c.

  {
    super.SetActions();
 
    AddAction(ActionAttachToConstruction);
    AddAction(ActionNextCombinationLockDial);
    AddAction(ActionDialCombinationLock);
    AddAction(ActionNextCombinationLockDialOnTarget);
    AddAction(ActionDialCombinationLockOnTarget);
  }

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

SetBaseLockValues()

void SetBaseLockValues ( )

protected

Definition at line 45 of file CombinationLock.c.

  {
    //set lock init values
    m_LockDigits = 3;
    m_Combination = 111;
    m_CombinationLocked = 999;
    m_IsLocked = false;
  }

References m_Combination, m_CombinationLocked, m_IsLocked, and m_LockDigits.

SetCombination()

void SetCombination ( int combination )

protected

Definition at line 175 of file CombinationLock.c.

  {
    m_Combination = combination;
  }

References m_Combination.

Referenced by DialNextNumber(), and ShuffleLock().

SetCombinationLocked()

void SetCombinationLocked ( int combination )

protected

Definition at line 180 of file CombinationLock.c.

  {
    m_CombinationLocked = combination;
  }

References m_CombinationLocked.

Referenced by LockServer().

SetInitialized()

void SetInitialized ( )

protected

Definition at line 65 of file CombinationLock.c.

  {
    m_IsInitialized = true;
  }

References m_IsInitialized.

Referenced by EEInit().

SetNextDial()

void SetNextDial ( )

protected

Definition at line 235 of file CombinationLock.c.

  {
    if (m_LockDigits > 1)
    {
      if (m_DialIndex <= m_LockDigits - 2)
        m_DialIndex++;
      else if (m_DialIndex >= m_LockDigits > - 1)
        m_DialIndex = 0;
    }
    else
      m_DialIndex = 0;
 
    //performed action
    m_LockActionPerformed = LockAction.DIAL_NUMBER_CHANED;
    //synchronize
    Synchronize();
  }

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

ShowAttached()

void ShowAttached ( )

protected

Definition at line 421 of file CombinationLock.c.

  {
    SetAnimationPhase("Combination_Lock_Attached", 0);
    SetAnimationPhase("Lock_Attached_1", 0);
    SetAnimationPhase("Lock_Attached_2", 0);
  }

Referenced by UpdateVisuals().

ShowItem()

void ShowItem ( )

protected

Definition at line 407 of file CombinationLock.c.

  {
    SetAnimationPhase("Combination_Lock_Item", 0);
    SetAnimationPhase("Lock_Item_1", 0);
    SetAnimationPhase("Lock_Item_2", 0);
  }

Referenced by UpdateVisuals().

ShuffleLock()

void ShuffleLock ( )

protected

Definition at line 313 of file CombinationLock.c.

  {
    string combination_text = m_Combination.ToString();
    string shuffled_text;
 
    //insert zeros to dials with 0 value
    int length_diff = m_LockDigits - combination_text.Length();
    for (int i = 0; i < length_diff; ++i)
      combination_text = "0" + combination_text;
 
    //assemble the whole combination with increased part
    for (int j = 0; j < combination_text.Length(); ++j)
    {
      int dial_number = combination_text.Get(j).ToInt();
      dial_number = (dial_number + Math.RandomInt(1, 9)) % 10;
      shuffled_text = shuffled_text + dial_number.ToString();
    }
 
    SetCombination(shuffled_text.ToInt());
  }

References m_Combination, m_LockDigits, Math::RandomInt(), and SetCombination().

Referenced by LockServer().

SoundLockChangeDial()

void SoundLockChangeDial ( )

protected

Definition at line 454 of file CombinationLock.c.

  {
    PlaySoundSet(m_Sound, SOUND_LOCK_CHANGE_DIAL, 0, 0);
  }

References m_Sound, and SOUND_LOCK_CHANGE_DIAL.

Referenced by UpdateSound().

SoundLockChangeNumber()

void SoundLockChangeNumber ( )

protected

Definition at line 449 of file CombinationLock.c.

  {
    PlaySoundSet(m_Sound, SOUND_LOCK_CHANGE_NUMBER, 0, 0);
  }

References m_Sound, and SOUND_LOCK_CHANGE_NUMBER.

Referenced by UpdateSound().

SoundLockClose()

void SoundLockClose ( )

protected

Definition at line 444 of file CombinationLock.c.

  {
    PlaySoundSet(m_Sound, SOUND_LOCK_CLOSE, 0, 0);
  }

References m_Sound, and SOUND_LOCK_CLOSE.

Referenced by UpdateSound().

SoundLockOpen()

void SoundLockOpen ( )

protected

Definition at line 439 of file CombinationLock.c.

  {
    PlaySoundSet(m_Sound, SOUND_LOCK_OPEN, 0, 0);
  }

References m_Sound, and SOUND_LOCK_OPEN.

Referenced by UpdateSound().

Synchronize()

void Synchronize ( )

protected

Definition at line 145 of file CombinationLock.c.

  {
    if (LogManager.IsBaseBuildingLogEnable()) bsbDebugPrint("[bsb] CombinationLock.Synchronize " + " m_Combination=" + m_Combination + " m_CombinationLocked=" + m_CombinationLocked);
    if (GetGame().IsServer())
    {
      SetSynchDirty();
      GetGame().GetCallQueue(CALL_CATEGORY_SYSTEM).CallLater(ResetActionVar, 1000); //synced var used to trigger client sound needs to be reset after triggering the sound
      UpdateVisuals();
    }
  }

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

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

UnlockServer()

void UnlockServer ( EntityAI player, EntityAI parent )

protected

Definition at line 281 of file CombinationLock.c.

  {
    if (LogManager.IsBaseBuildingLogEnable()) bsbDebugPrint("[bsb] CombinationLock.UnlockServer " + " m_Combination=" + m_Combination + " m_CombinationLocked=" + m_CombinationLocked);
    if (IsLockAttached())
    {
      Fence fence = Fence.Cast(parent);
 
      //set slot unlock
      InventoryLocation inventory_location = new InventoryLocation;
      GetInventory().GetCurrentInventoryLocation(inventory_location);
      fence.GetInventory().SetSlotLock(inventory_location.GetSlot(), false);
 
      //drop entity from attachment slot
      if (player)
        player.ServerDropEntity(this);
      else
        parent.GetInventory().DropEntity(InventoryMode.SERVER, parent, this);
      SetPosition(fence.GetKitSpawnPosition());
      PlaceOnSurface();
 
      m_LockActionPerformed = LockAction.UNLOCKED;
      SetTakeable(true);
      CheckLockedStateServer();
      //synchronize
      Synchronize();
    }
 
    //reset performed action
    //m_LockActionPerformed = LockAction.NONE;
  }

References bsbDebugPrint(), CheckLockedStateServer(), LogManager::IsBaseBuildingLogEnable(), IsLockAttached(), m_Combination, m_CombinationLocked, m_LockActionPerformed, SetPosition(), SetTakeable(), and Synchronize().

UpdateSound()

void UpdateSound ( )

protected

Definition at line 387 of file CombinationLock.c.

  {
    //was locked
    if (m_LockActionPerformed == LockAction.LOCKED)
      SoundLockClose();
 
    //was unlocked
    if (m_LockActionPerformed == LockAction.UNLOCKED)
      SoundLockOpen();
 
    //next dial index
    if (m_LockActionPerformed == LockAction.DIAL_INDEX_CHANGED)
      SoundLockChangeDial();
 
    //dialed new number
    if (m_LockActionPerformed == LockAction.DIAL_NUMBER_CHANED)
      SoundLockChangeNumber();
  }

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

Referenced by OnVariablesSynchronized().

UpdateVisuals()

void UpdateVisuals ( )

protected

Definition at line 372 of file CombinationLock.c.

  {
    //Client/Server
    if (IsLockedOnGate())
    {
      GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).CallLater(HideItem, 0, false);
      GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).CallLater(ShowAttached, 0, false);
    }
    else
    {
      GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).CallLater(ShowItem, 0, false);
      GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).CallLater(HideAttached, 0, false);
    }
  }

References CALL_CATEGORY_GAMEPLAY, GetGame(), HideAttached(), HideItem(), IsLockedOnGate(), ShowAttached(), and ShowItem().

Variable Documentation

m_Combination

int m_Combination

Definition at line 15 of file CombinationLock.c.

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

m_CombinationLocked

int m_CombinationLocked

Definition at line 16 of file CombinationLock.c.

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

m_DialIndex

int m_DialIndex

Definition at line 17 of file CombinationLock.c.

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

m_IsInitialized

bool m_IsInitialized

protected

Definition at line 22 of file CombinationLock.c.

Referenced by IsInitialized(), and SetInitialized().

m_IsLocked

bool m_IsLocked

protected

Definition at line 18 of file CombinationLock.c.

m_LockActionPerformed

LockAction m_LockActionPerformed = LockAction.NONE

protected

Definition at line 20 of file CombinationLock.c.

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

EffectSound m_Sound

protected

Definition at line 31 of file CombinationLock.c.

SOUND_LOCK_CHANGE_DIAL

const string SOUND_LOCK_CHANGE_DIAL = "combinationlock_changedial_SoundSet"

protected

Definition at line 29 of file CombinationLock.c.

Referenced by SoundLockChangeDial().

SOUND_LOCK_CHANGE_NUMBER

const string SOUND_LOCK_CHANGE_NUMBER = "combinationlock_changenumber_SoundSet"

protected

Definition at line 28 of file CombinationLock.c.

Referenced by SoundLockChangeNumber().

SOUND_LOCK_CLOSE

const string SOUND_LOCK_CLOSE = "combinationlock_close_SoundSet"

protected

Definition at line 27 of file CombinationLock.c.

Referenced by SoundLockClose().

SOUND_LOCK_OPEN

const string SOUND_LOCK_OPEN = "combinationlock_open_SoundSet"

protected

Definition at line 26 of file CombinationLock.c.

Referenced by SoundLockOpen().