Land_Underground_EntranceBase Class Reference

Inheritance diagram for Land_Underground_EntranceBase:

Collaboration diagram for Land_Underground_EntranceBase:

Private Member Functions
void	Land_Underground_EntranceBase ()
void	CreateLights ()
void	~Land_Underground_EntranceBase ()
void	CleanUpOnDeleteClient ()
void	CleanUpOnClosedClient ()
bool	CanManipulate (Param param=null)
void	Manipulate (Param param=null)
void	NavmeshUpdate ()
void	OnUpdateClient (float timeSlice)
override void	EOnPostSimulate (IEntity other, float timeSlice)
void	OnUpdateServer ()
void	GetConnectedPanels (array< Land_Underground_Panel > panels)
bool	CheckShouldPlayPersistent (EUndegroundEntranceState state, EUndegroundEntranceState lastValidState)
float	AdjustTime (float originalTime, float adjustedTime=-1)
float	GetOpeningTime ()
void	RequestLatentTransition (float time, EUndegroundEntranceState targetState=EUndegroundEntranceState.UNINITIALIZED)
void	SetDoorStateServer (EUndegroundEntranceState newState)
void	OnDoorStateChangedServer (EUndegroundEntranceState newState)
void	OnDoorStateChangedClient (EUndegroundEntranceState newState, EUndegroundEntranceState prevState)
void	OpenServer (bool force=false)
void	HandleVisualPlayback (EUndegroundEntranceState newState, EUndegroundEntranceState prevState)
void	HandleAudioPlayback (EUndegroundEntranceState newState, EUndegroundEntranceState prevState)
void	OnFinishedTimerServer ()
override void	OnVariablesSynchronized ()
bool	IsInitDoorStateSync ()

Private Attributes
EUndegroundEntranceState	m_DoorState = EUndegroundEntranceState.CLOSED
EUndegroundEntranceState	m_DoorStatePrev = EUndegroundEntranceState.UNINITIALIZED
float	m_AnimPhase
ref AnimationTimer	m_AnimTimerDoorServer
ref Timer	m_NavmeshTimer
ref array< Land_Underground_Panel >	m_ConnectedPanels
EUndegroundDoorType	m_DoorType
EntranceLight	m_InteriorLight1
EntranceLight	m_InteriorLight2
EntranceLight	m_InteriorLight3

Detailed Description

Definition at line 51 of file Land_Underground_Entrance.c.

Constructor & Destructor Documentation

Land_Underground_EntranceBase()

void Land_Underground_EntranceBase::Land_Underground_EntranceBase ( )

inlineprivate

Definition at line 65 of file Land_Underground_Entrance.c.

  {
    m_DoorType = EUndegroundDoorType.MAIN;
    Land_Underground_Panel.RegisterEntrance(this);
    RegisterNetSyncVariableFloat("m_AnimPhase", 0, 1, 5);
    RegisterNetSyncVariableInt("m_DoorState", 0, EnumTools.GetLastEnumValue(EUndegroundEntranceState));
 
#ifndef SERVER
    GetGame().GetCallQueue(CALL_CATEGORY_SYSTEM).CallLater(CreateLights, 250);
#endif
  }

References CALL_CATEGORY_SYSTEM, CreateLights(), GetGame(), EnumTools::GetLastEnumValue(), and m_DoorType.

~Land_Underground_EntranceBase()

void Land_Underground_EntranceBase::~Land_Underground_EntranceBase ( )

inlineprivate

Definition at line 79 of file Land_Underground_Entrance.c.

  {
    Land_Underground_Panel.UnregisterEntrance(this);
#ifndef SERVER
    CleanUpOnDeleteClient();
#endif
  }

References CleanUpOnDeleteClient().

Member Function Documentation

AdjustTime()

float Land_Underground_EntranceBase::AdjustTime ( float originalTime, float adjustedTime = -1 )

inlineprivate

Definition at line 150 of file Land_Underground_Entrance.c.

  {
#ifdef DIAG_DEVELOPER
    float timeAccel = 1;
 
    if (adjustedTime != -1)
      return adjustedTime;
    if (FeatureTimeAccel.GetFeatureTimeAccelEnabled(ETimeAccelCategories.UNDERGROUND_ENTRANCE))
    {
      timeAccel = FeatureTimeAccel.GetFeatureTimeAccelValue();
      return originalTime / timeAccel;
    }
#endif
    return originalTime;
  }

Referenced by Land_Underground_Stairs_Exit::GetOpeningTime(), Land_Underground_Stairs_Exit::OnDoorStateChangedServer(), and OnUpdateServer().

CanManipulate()

bool Land_Underground_EntranceBase::CanManipulate ( Param param = null )

inlineprivate

Definition at line 98 of file Land_Underground_Entrance.c.

  {
    return m_DoorState == EUndegroundEntranceState.CLOSED;
  }

References m_DoorState.

Referenced by CanInteract().

CheckShouldPlayPersistent()

bool Land_Underground_EntranceBase::CheckShouldPlayPersistent ( EUndegroundEntranceState state, EUndegroundEntranceState lastValidState )

inlineprivate

Definition at line 145 of file Land_Underground_Entrance.c.

  {
    return m_DoorState == state || (IsInitDoorStateSync() && m_DoorState > state && m_DoorState <= lastValidState);
  }

References IsInitDoorStateSync(), and m_DoorState.

CleanUpOnClosedClient()

void Land_Underground_EntranceBase::CleanUpOnClosedClient ( )

private

Referenced by CleanUpOnDeleteClient(), and OnDoorStateChangedClient().

CleanUpOnDeleteClient()

void Land_Underground_EntranceBase::CleanUpOnDeleteClient ( )

inlineprivate

Definition at line 89 of file Land_Underground_Entrance.c.

  {
    //anything we might have started playing when the door was activated
    CleanUpOnClosedClient();
  }

References CleanUpOnClosedClient().

Referenced by ~Land_Underground_EntranceBase().

CreateLights()

void Land_Underground_EntranceBase::CreateLights ( )

private

Referenced by Land_Underground_EntranceBase().

EOnPostSimulate()

override void Land_Underground_EntranceBase::EOnPostSimulate ( IEntity other, float timeSlice )

inlineprivate

Definition at line 114 of file Land_Underground_Entrance.c.

  {
#ifndef SERVER
    OnUpdateClient(timeSlice);
#endif
  }

References OnUpdateClient().

GetConnectedPanels()

void Land_Underground_EntranceBase::GetConnectedPanels ( array< Land_Underground_Panel > panels )

inlineprivate

Definition at line 131 of file Land_Underground_Entrance.c.

  {
    if (!Land_Underground_Panel.m_Panels)
      return;
    foreach (Land_Underground_Panel p: Land_Underground_Panel.m_Panels)
    {
      if (p.GetClosestDoor() == this)
        panels.Insert(p);
    }
  }

Referenced by OnDoorStateChangedClient().

GetOpeningTime()

float Land_Underground_EntranceBase::GetOpeningTime ( )

inlineprivate

Definition at line 166 of file Land_Underground_Entrance.c.

  {
    return 30;
  }

Referenced by OnUpdateServer().

HandleAudioPlayback()

void Land_Underground_EntranceBase::HandleAudioPlayback ( EUndegroundEntranceState newState, EUndegroundEntranceState prevState )

private

Referenced by OnDoorStateChangedClient().

HandleVisualPlayback()

void Land_Underground_EntranceBase::HandleVisualPlayback ( EUndegroundEntranceState newState, EUndegroundEntranceState prevState )

private

Referenced by OnDoorStateChangedClient().

IsInitDoorStateSync()

bool Land_Underground_EntranceBase::IsInitDoorStateSync ( )

inlineprivate

Definition at line 232 of file Land_Underground_Entrance.c.

  {
    return m_DoorStatePrev == EUndegroundEntranceState.UNINITIALIZED;
  }

References m_DoorStatePrev.

Referenced by CheckShouldPlayPersistent().

Manipulate()

void Land_Underground_EntranceBase::Manipulate ( Param param = null )

inlineprivate

Definition at line 103 of file Land_Underground_Entrance.c.

  {
    OpenServer();
  }

References OpenServer().

Referenced by Interact().

NavmeshUpdate()

void Land_Underground_EntranceBase::NavmeshUpdate ( )

inlineprivate

Definition at line 108 of file Land_Underground_Entrance.c.

  {
  }

OnDoorStateChangedClient()

void Land_Underground_EntranceBase::OnDoorStateChangedClient ( EUndegroundEntranceState newState, EUndegroundEntranceState prevState )

inlineprivate

Definition at line 187 of file Land_Underground_Entrance.c.

  {
    if (newState > EUndegroundEntranceState.CLOSED)
      SetEventMask(EntityEvent.POSTSIMULATE);
    else
    {
      ClearEventMask(EntityEvent.POSTSIMULATE);
      CleanUpOnClosedClient();
    }
 
    HandleAudioPlayback(newState, prevState);
    HandleVisualPlayback(newState, prevState);
 
    if (!m_ConnectedPanels)
    {
      m_ConnectedPanels = new array<Land_Underground_Panel>();
      GetConnectedPanels(m_ConnectedPanels);
    }
    foreach (Land_Underground_Panel p: m_ConnectedPanels)
      p.OnDoorStateChangedClient(newState, prevState);
  }

References CleanUpOnClosedClient(), GetConnectedPanels(), HandleAudioPlayback(), HandleVisualPlayback(), and m_ConnectedPanels.

Referenced by OnVariablesSynchronized().

OnDoorStateChangedServer()

void Land_Underground_EntranceBase::OnDoorStateChangedServer ( EUndegroundEntranceState newState )

private

Referenced by SetDoorStateServer().

OnFinishedTimerServer()

void Land_Underground_EntranceBase::OnFinishedTimerServer ( )

private

OnUpdateClient()

void Land_Underground_EntranceBase::OnUpdateClient ( float timeSlice )

private

Referenced by EOnPostSimulate().

OnUpdateServer()

void Land_Underground_EntranceBase::OnUpdateServer ( )

inlineprivate

Definition at line 121 of file Land_Underground_Entrance.c.

  {
    m_AnimPhase = m_AnimTimerDoorServer.GetValue() / AdjustTime(GetOpeningTime());// make 0..1
    SetAnimationPhaseNow("EntranceDoor", m_AnimPhase);
 
    GetGame().GetWorld().UpdatePathgraphDoorByAnimationSourceName(this, "EntranceDoor");
 
    SetSynchDirty();
  }

References AdjustTime(), GetGame(), GetOpeningTime(), m_AnimPhase, and m_AnimTimerDoorServer.

OnVariablesSynchronized()

override void Land_Underground_EntranceBase::OnVariablesSynchronized ( )

inlineprivate

Definition at line 221 of file Land_Underground_Entrance.c.

  {
    super.OnVariablesSynchronized();
 
    if (m_DoorState != m_DoorStatePrev)
    {
      OnDoorStateChangedClient(m_DoorState, m_DoorStatePrev);
      m_DoorStatePrev = m_DoorState;
    }
  }

References m_DoorState, m_DoorStatePrev, and OnDoorStateChangedClient().

OpenServer()

void Land_Underground_EntranceBase::OpenServer ( bool force = false )

inlineprivate

Definition at line 209 of file Land_Underground_Entrance.c.

  {
    GetGame().RegisterNetworkStaticObject(this);
    if (m_DoorState == EUndegroundEntranceState.CLOSED || force)
      SetDoorStateServer(EUndegroundEntranceState.OPENING_A);
  }

References GetGame(), m_DoorState, and SetDoorStateServer().

Referenced by Manipulate().

RequestLatentTransition()

void Land_Underground_EntranceBase::RequestLatentTransition ( float time, EUndegroundEntranceState targetState = EUndegroundEntranceState.UNINITIALIZED )

inlineprivate

Definition at line 171 of file Land_Underground_Entrance.c.

  {
    if (targetState == EUndegroundEntranceState.UNINITIALIZED)
      targetState = m_DoorState + 1;
    GetGame().GetCallQueue(CALL_CATEGORY_SYSTEM).CallLater(SetDoorStateServer, time * 1000, false, targetState);
  }

References CALL_CATEGORY_SYSTEM, GetGame(), m_DoorState, and SetDoorStateServer().

Referenced by Land_Underground_Stairs_Exit::OnDoorStateChangedServer().

SetDoorStateServer()

void Land_Underground_EntranceBase::SetDoorStateServer ( EUndegroundEntranceState newState )

inlineprivate

Definition at line 178 of file Land_Underground_Entrance.c.

  {
    m_DoorState = newState;
    OnDoorStateChangedServer(newState);
    SetSynchDirty();
  }

References m_DoorState, and OnDoorStateChangedServer().

Referenced by OpenServer(), and RequestLatentTransition().

Member Data Documentation

m_AnimPhase

float Land_Underground_EntranceBase::m_AnimPhase

private

Definition at line 55 of file Land_Underground_Entrance.c.

Referenced by OnUpdateServer().

m_AnimTimerDoorServer

ref AnimationTimer Land_Underground_EntranceBase::m_AnimTimerDoorServer

private

Definition at line 56 of file Land_Underground_Entrance.c.

Referenced by Land_Underground_Stairs_Exit::OnDoorStateChangedServer(), and OnUpdateServer().

m_ConnectedPanels

ref array<Land_Underground_Panel> Land_Underground_EntranceBase::m_ConnectedPanels

private

Definition at line 58 of file Land_Underground_Entrance.c.

Referenced by OnDoorStateChangedClient().

m_DoorState

EUndegroundEntranceState Land_Underground_EntranceBase::m_DoorState = EUndegroundEntranceState.CLOSED

private

Definition at line 53 of file Land_Underground_Entrance.c.

Referenced by CanManipulate(), CheckShouldPlayPersistent(), OnVariablesSynchronized(), OpenServer(), RequestLatentTransition(), and SetDoorStateServer().

m_DoorStatePrev

EUndegroundEntranceState Land_Underground_EntranceBase::m_DoorStatePrev = EUndegroundEntranceState.UNINITIALIZED

private

Definition at line 54 of file Land_Underground_Entrance.c.

Referenced by IsInitDoorStateSync(), and OnVariablesSynchronized().

m_DoorType

EUndegroundDoorType Land_Underground_EntranceBase::m_DoorType

private

Definition at line 59 of file Land_Underground_Entrance.c.

Referenced by GetLinkedDoorType(), Land_Underground_EntranceBase(), and Land_Underground_Stairs_Exit::Land_Underground_Stairs_Exit().

m_InteriorLight1

EntranceLight Land_Underground_EntranceBase::m_InteriorLight1

private

Definition at line 61 of file Land_Underground_Entrance.c.

Referenced by Land_Underground_Stairs_Exit::CreateLights().

m_InteriorLight2

EntranceLight Land_Underground_EntranceBase::m_InteriorLight2

private

Definition at line 62 of file Land_Underground_Entrance.c.

Referenced by Land_Underground_Stairs_Exit::CreateLights().

m_InteriorLight3

EntranceLight Land_Underground_EntranceBase::m_InteriorLight3

private

Definition at line 63 of file Land_Underground_Entrance.c.

m_NavmeshTimer

ref Timer Land_Underground_EntranceBase::m_NavmeshTimer

private

Definition at line 57 of file Land_Underground_Entrance.c.

---

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

• scripts/4_World/Entities/Building/Underground/Entrance/Land_Underground_Entrance.c