PlayerBase Class Reference

Collaboration diagram for PlayerBase:

Private Member Functions
override void	OnGameplayDataHandlerSync ()

Static Private Member Functions
static void	CreatePersonalLight ()
	Creates PL if it doesn't exist already.
static void	SwitchPersonalLight (bool state)
	Controls the ON/OFF switch of the Personal Light. PL will still shine only if the server allows it.
static void	UpdatePersonalLight ()
	Updates state of PL.
static void	UpdateHitDirectionValues ()

Static Private Attributes
static ScriptedLightBase	m_PersonalLight
static bool	m_PersonalLightEnabledOnCurrentServer = false
static bool	m_PersonalLightDisabledByDebug = false
static bool	m_PersonalLightIsSwitchedOn = true

Detailed Description

Definition at line 1 of file PlayerBaseClient.c.

Member Function Documentation

CreatePersonalLight()

static void PlayerBase::CreatePersonalLight ( )

inlinestaticprivate

Creates PL if it doesn't exist already.

Definition at line 9 of file PlayerBaseClient.c.

  {
    if (!m_PersonalLight && (!GetGame().IsServer() || !GetGame().IsMultiplayer()))
      m_PersonalLight = ScriptedLightBase.CreateLight(PersonalLight, "0 0 0");
  }

References GetGame().

OnGameplayDataHandlerSync()

override void PlayerBase::OnGameplayDataHandlerSync ( )

inlineprivate

Definition at line 37 of file PlayerBaseClient.c.

  {
    super.OnGameplayDataHandlerSync();
    m_PersonalLightEnabledOnCurrentServer = !CfgGameplayHandler.GetDisablePersonalLight();
    UpdatePersonalLight();
    UpdateHitDirectionValues();
  }

References CfgGameplayHandler::GetDisablePersonalLight().

Referenced by ManBase::OnSelectPlayer().

SwitchPersonalLight()

static void PlayerBase::SwitchPersonalLight ( bool state )

inlinestaticprivate

Controls the ON/OFF switch of the Personal Light. PL will still shine only if the server allows it.

Definition at line 47 of file PlayerBaseClient.c.

  {
    if (!GetGame().IsServer() || !GetGame().IsMultiplayer())
    {
      m_PersonalLightIsSwitchedOn = state;
      UpdatePersonalLight();
    }
  }

References GetGame().

UpdateHitDirectionValues()

static void PlayerBase::UpdateHitDirectionValues ( )

inlinestaticprivate

Definition at line 70 of file PlayerBaseClient.c.

  {
    HitDirectionEffectBase.CheckValues();
  }

References HitDirectionEffectBase::CheckValues().

UpdatePersonalLight()

static void PlayerBase::UpdatePersonalLight ( )

inlinestaticprivate

Updates state of PL.

Definition at line 57 of file PlayerBaseClient.c.

  {
    string param;
 
    CreatePersonalLight();
 
    // Allow PL unless it's disabled by debug or client-side starting parameter
    if (!GetCLIParam("disablePersonalLight", param) && !m_PersonalLightDisabledByDebug && m_PersonalLightIsSwitchedOn)
      m_PersonalLight.SetEnabled(m_PersonalLightEnabledOnCurrentServer);
    else
      m_PersonalLight.SetEnabled(false);
  }

References GetCLIParam().

Member Data Documentation

m_PersonalLight

ScriptedLightBase PlayerBase::m_PersonalLight

staticprivate

Definition at line 3 of file PlayerBaseClient.c.

m_PersonalLightDisabledByDebug

bool PlayerBase::m_PersonalLightDisabledByDebug = false

staticprivate

Definition at line 5 of file PlayerBaseClient.c.

m_PersonalLightEnabledOnCurrentServer

bool PlayerBase::m_PersonalLightEnabledOnCurrentServer = false

staticprivate

Definition at line 4 of file PlayerBaseClient.c.

m_PersonalLightIsSwitchedOn

bool PlayerBase::m_PersonalLightIsSwitchedOn = true

staticprivate

Definition at line 6 of file PlayerBaseClient.c.

---

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

• scripts/4_World/Entities/ManBase/PlayerBaseClient.c