PC Stable Documentation
 
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Mission Class Reference

Mission class. More...

Private Member Functions

private void ~Mission ()
 
void OnInit ()
 
void OnMissionStart ()
 
void OnMissionFinish ()
 
void OnUpdate (float timeslice)
 
void OnKeyPress (int key)
 
void OnKeyRelease (int key)
 
void OnMouseButtonPress (int button)
 
void OnMouseButtonRelease (int button)
 
void OnEvent (EventType eventTypeId, Param params)
 
void OnItemUsed (InventoryItem item, Man owner)
 
void AddDummyPlayerToScheduler (Man player)
 
void Reset ()
 
void ResetGUI ()
 
void OnGameplayDataHandlerLoad ()
 
Hud GetHud ()
 
ObjectSnapCallback GetInventoryDropCallback ()
 
bool IsPlayerDisconnecting (Man player)
 
UIScriptedMenu CreateScriptedMenu (int id)
 
UIScriptedWindow CreateScriptedWindow (int id)
 
WorldData GetWorldData ()
 
WorldLighting GetWorldLighting ()
 
DynamicMusicPlayer GetDynamicMusicPlayer ()
 
bool IsPaused ()
 
bool IsGame ()
 
bool IsServer ()
 
void Pause ()
 
void Continue ()
 
void AbortMission ()
 
void CreateLogoutMenu (UIMenuPanel parent)
 
void StartLogoutMenu (int time)
 
void CreateDebugMonitor ()
 
void HideDebugMonitor ()
 
void RefreshCrosshairVisibility ()
 
void HideCrosshairVisibility ()
 
bool IsMissionGameplay ()
 
bool IsControlDisabled ()
 
int GetControlDisabledMode ()
 
void PlayerControlEnable (bool bForceSupress)
 
void PlayerControlDisable (int mode)
 deprecated
 
void RemoveActiveInputExcludes (array< string > excludes, bool bForceSupress=false)
 deprecated
 
void RemoveActiveInputRestriction (int restrictor)
 
void AddActiveInputExcludes (array< string > excludes)
 
void AddActiveInputRestriction (int restrictor)
 
void RefreshExcludes ()
 
bool IsInputExcludeActive (string exclude)
 
bool IsInputRestrictionActive (int restriction)
 
void EnableAllInputs (bool bForceSupress=false)
 
void ShowInventory ()
 
void HideInventory ()
 
void ShowChat ()
 
void HideChat ()
 
void UpdateVoiceLevelWidgets (int level)
 
void HideVoiceLevelWidgets ()
 
bool IsVoNActive ()
 
void SetVoNActive (bool active)
 
bool InsertCorpse (Man player)
 
UIScriptedMenu GetNoteMenu ()
 
void SetNoteMenu (UIScriptedMenu menu)
 
void SetPlayerRespawning (bool state)
 
void OnPlayerRespawned (Man player)
 
bool IsPlayerRespawning ()
 
array< vectorGetActiveRefresherLocations ()
 
void SetRespawnModeClient (int mode)
 for client-side usage
 
int GetRespawnModeClient ()
 
void SyncRespawnModeInfo (PlayerIdentity identity)
 server-side
 
ImageWidget GetMicrophoneIcon ()
 
WidgetFadeTimer GetMicWidgetFadeTimer ()
 
GameplayEffectWidgets_base GetEffectWidgets ()
 
map< int, ImageWidget > GetVoiceLevelWidgets ()
 
map< int, ref WidgetFadeTimer > GetVoiceLevelTimers ()
 
ScriptInvoker GetOnInputDeviceChanged ()
 
ScriptInvoker GetOnInputPresetChanged ()
 
ScriptInvoker GetOnInputDeviceConnected ()
 
ScriptInvoker GetOnInputDeviceDisconnected ()
 
ScriptInvoker GetOnModMenuVisibilityChanged ()
 
ScriptInvoker GetOnTimeChanged ()
 
RainProcurementHandler GetRainProcurementHandler ()
 

Private Attributes

ScriptModule MissionScript
 
ref array< vectorm_ActiveRefresherLocations
 
protected ref ScriptInvoker m_OnInputDeviceChanged = new ScriptInvoker()
 
protected ref ScriptInvoker m_OnInputPresetChanged = new ScriptInvoker()
 
protected ref ScriptInvoker m_OnInputDeviceConnected = new ScriptInvoker()
 
protected ref ScriptInvoker m_OnInputDeviceDisconnected = new ScriptInvoker()
 
protected ref ScriptInvoker m_OnModMenuVisibilityChanged = new ScriptInvoker()
 
protected ref ScriptInvoker m_OnTimeChanged = new ScriptInvoker()
 

Detailed Description

Mission class.

Constructor & Destructor Documentation

◆ ~Mission()

private void ~Mission ( )
private

Member Function Documentation

◆ AbortMission()

◆ AddActiveInputExcludes()

◆ AddActiveInputRestriction()

void AddActiveInputRestriction ( int  restrictor)
private

◆ AddDummyPlayerToScheduler()

void AddDummyPlayerToScheduler ( Man  player)
inlineprivate

◆ Continue()

◆ CreateDebugMonitor()

void CreateDebugMonitor ( )
inlineprivate

◆ CreateLogoutMenu()

void CreateLogoutMenu ( UIMenuPanel  parent)
inlineprivate

◆ CreateScriptedMenu()

UIScriptedMenu CreateScriptedMenu ( int  id)
inlineprivate

◆ CreateScriptedWindow()

UIScriptedWindow CreateScriptedWindow ( int  id)
inlineprivate

Referenced by UIManager::OpenWindow().

◆ EnableAllInputs()

void EnableAllInputs ( bool  bForceSupress = false)
private

◆ GetActiveRefresherLocations()

array< vector > GetActiveRefresherLocations ( )
private

◆ GetControlDisabledMode()

int GetControlDisabledMode ( )
inlineprivate

◆ GetDynamicMusicPlayer()

DynamicMusicPlayer GetDynamicMusicPlayer ( )
inlineprivate

◆ GetEffectWidgets()

◆ GetHud()

◆ GetInventoryDropCallback()

ObjectSnapCallback GetInventoryDropCallback ( )
inlineprivate

◆ GetMicrophoneIcon()

ImageWidget GetMicrophoneIcon ( )
inlineprivate

◆ GetMicWidgetFadeTimer()

WidgetFadeTimer GetMicWidgetFadeTimer ( )
private

Referenced by ShowVoiceNotification().

◆ GetNoteMenu()

UIScriptedMenu GetNoteMenu ( )
private

◆ GetOnInputDeviceChanged()

◆ GetOnInputDeviceConnected()

◆ GetOnInputDeviceDisconnected()

ScriptInvoker GetOnInputDeviceDisconnected ( )
inlineprivate

◆ GetOnInputPresetChanged()

◆ GetOnModMenuVisibilityChanged()

◆ GetOnTimeChanged()

ScriptInvoker GetOnTimeChanged ( )
inlineprivate

References m_OnTimeChanged.

◆ GetRainProcurementHandler()

RainProcurementHandler GetRainProcurementHandler ( )
inlineprivate

◆ GetRespawnModeClient()

int GetRespawnModeClient ( )
inlineprivate

◆ GetVoiceLevelTimers()

map< int, ref WidgetFadeTimer > GetVoiceLevelTimers ( )
private

Referenced by ShowVoiceNotification().

◆ GetVoiceLevelWidgets()

map< int, ImageWidget > GetVoiceLevelWidgets ( )
private

Referenced by ShowVoiceNotification().

◆ GetWorldData()

◆ GetWorldLighting()

WorldLighting GetWorldLighting ( )
inlineprivate

Referenced by ManBase::UpdateLighting().

◆ HideChat()

void HideChat ( )
inlineprivate

Referenced by UIScriptedMenu::OnHide().

◆ HideCrosshairVisibility()

void HideCrosshairVisibility ( )
inlineprivate

◆ HideDebugMonitor()

void HideDebugMonitor ( )
inlineprivate

◆ HideInventory()

◆ HideVoiceLevelWidgets()

void HideVoiceLevelWidgets ( )
inlineprivate

◆ InsertCorpse()

bool InsertCorpse ( Man  player)
inlineprivate

◆ IsControlDisabled()

bool IsControlDisabled ( )
inlineprivate

◆ IsGame()

bool IsGame ( )
inlineprivate

◆ IsInputExcludeActive()

bool IsInputExcludeActive ( string  exclude)
private

◆ IsInputRestrictionActive()

bool IsInputRestrictionActive ( int  restriction)
private

◆ IsMissionGameplay()

bool IsMissionGameplay ( )
inlineprivate

◆ IsPaused()

bool IsPaused ( )
inlineprivate

◆ IsPlayerDisconnecting()

bool IsPlayerDisconnecting ( Man  player)
private

◆ IsPlayerRespawning()

bool IsPlayerRespawning ( )
private

◆ IsServer()

bool IsServer ( )
inlineprivate

◆ IsVoNActive()

bool IsVoNActive ( )
inlineprivate

Referenced by HandleInput(), and UpdateVoiceIcon().

◆ OnEvent()

void OnEvent ( EventType  eventTypeId,
Param  params 
)
inlineprivate

Referenced by CGame::OnEvent().

◆ OnGameplayDataHandlerLoad()

void OnGameplayDataHandlerLoad ( )
inlineprivate

◆ OnInit()

void OnInit ( )
inlineprivate

◆ OnItemUsed()

void OnItemUsed ( InventoryItem  item,
Man  owner 
)
inlineprivate

◆ OnKeyPress()

void OnKeyPress ( int  key)
inlineprivate

Referenced by CGame::OnKeyPress().

◆ OnKeyRelease()

void OnKeyRelease ( int  key)
inlineprivate

Referenced by CGame::OnKeyRelease().

◆ OnMissionFinish()

void OnMissionFinish ( )
inlineprivate

◆ OnMissionStart()

void OnMissionStart ( )
inlineprivate

◆ OnMouseButtonPress()

void OnMouseButtonPress ( int  button)
inlineprivate

◆ OnMouseButtonRelease()

void OnMouseButtonRelease ( int  button)
inlineprivate

◆ OnPlayerRespawned()

void OnPlayerRespawned ( Man  player)
private

Referenced by ManBase::OnPlayerLoaded().

◆ OnUpdate()

void OnUpdate ( float  timeslice)
inlineprivate

Referenced by CGame::OnUpdate().

◆ Pause()

void Pause ( )
inlineprivate

◆ PlayerControlDisable()

void PlayerControlDisable ( int  mode)
private

deprecated

◆ PlayerControlEnable()

void PlayerControlEnable ( bool  bForceSupress)
private

◆ RefreshCrosshairVisibility()

◆ RefreshExcludes()

void RefreshExcludes ( )
private

◆ RemoveActiveInputExcludes()

◆ RemoveActiveInputRestriction()

◆ Reset()

void Reset ( )
inlineprivate

◆ ResetGUI()

void ResetGUI ( )
inlineprivate

◆ SetNoteMenu()

void SetNoteMenu ( UIScriptedMenu  menu)
private

◆ SetPlayerRespawning()

void SetPlayerRespawning ( bool  state)
private

Referenced by ManBase::OnPlayerLoaded().

◆ SetRespawnModeClient()

void SetRespawnModeClient ( int  mode)
private

for client-side usage

Referenced by ManBase::OnGameplayDataHandlerSync().

◆ SetVoNActive()

void SetVoNActive ( bool  active)
inlineprivate

Referenced by OnEvent().

◆ ShowChat()

void ShowChat ( )
inlineprivate

◆ ShowInventory()

void ShowInventory ( )
inlineprivate

◆ StartLogoutMenu()

void StartLogoutMenu ( int  time)
inlineprivate

◆ SyncRespawnModeInfo()

void SyncRespawnModeInfo ( PlayerIdentity  identity)
private

server-side

Referenced by ManBase::EEKilled(), and ManBase::OnSelectPlayer().

◆ UpdateVoiceLevelWidgets()

void UpdateVoiceLevelWidgets ( int  level)
inlineprivate

Referenced by CGame::UpdateVoiceLevel().

Field Documentation

◆ m_ActiveRefresherLocations

◆ m_OnInputDeviceChanged

protected ref ScriptInvoker m_OnInputDeviceChanged = new ScriptInvoker()
private

Referenced by GetOnInputDeviceChanged().

◆ m_OnInputDeviceConnected

protected ref ScriptInvoker m_OnInputDeviceConnected = new ScriptInvoker()
private

◆ m_OnInputDeviceDisconnected

protected ref ScriptInvoker m_OnInputDeviceDisconnected = new ScriptInvoker()
private

◆ m_OnInputPresetChanged

protected ref ScriptInvoker m_OnInputPresetChanged = new ScriptInvoker()
private

Referenced by GetOnInputPresetChanged().

◆ m_OnModMenuVisibilityChanged

protected ref ScriptInvoker m_OnModMenuVisibilityChanged = new ScriptInvoker()
private

◆ m_OnTimeChanged

protected ref ScriptInvoker m_OnTimeChanged = new ScriptInvoker()
private

Referenced by GetOnTimeChanged().

◆ MissionScript

ScriptModule MissionScript
private

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