Mission Class Reference

Mission class. More...

Collaboration diagram for Mission:

Protected Attributes
ref ScriptInvoker	m_OnInputDeviceChanged = new ScriptInvoker()
ref ScriptInvoker	m_OnInputPresetChanged = new ScriptInvoker()
ref ScriptInvoker	m_OnInputDeviceConnected = new ScriptInvoker()
ref ScriptInvoker	m_OnInputDeviceDisconnected = new ScriptInvoker()
ref ScriptInvoker	m_OnModMenuVisibilityChanged = new ScriptInvoker()

Private Member Functions
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 ()
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< vector >	GetActiveRefresherLocations ()
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 ()
RainProcurementHandler	GetRainProcurementHandler ()

Private Attributes
ScriptModule	MissionScript
ref array< vector >	m_ActiveRefresherLocations

Detailed Description

Mission class.

Definition at line 667 of file gameplay.c.

Constructor & Destructor Documentation

~Mission()

void Mission::~Mission ( )

private

Member Function Documentation

AbortMission()

void Mission::AbortMission ( )

inlineprivate

Definition at line 751 of file gameplay.c.

{}

AddActiveInputExcludes()

void Mission::AddActiveInputExcludes ( array< string > excludes )

private

AddActiveInputRestriction()

void Mission::AddActiveInputRestriction ( int restrictor )

private

AddDummyPlayerToScheduler()

void Mission::AddDummyPlayerToScheduler ( Man player )

inlineprivate

Definition at line 696 of file gameplay.c.

{}

Continue()

void Mission::Continue ( )

inlineprivate

Definition at line 749 of file gameplay.c.

{}

Referenced by UIScriptedMenu::~InGameMenu(), and UIScriptedMenu::~InGameMenuXbox().

CreateDebugMonitor()

void Mission::CreateDebugMonitor ( )

inlineprivate

Definition at line 756 of file gameplay.c.

{}

CreateLogoutMenu()

void Mission::CreateLogoutMenu ( UIMenuPanel parent )

inlineprivate

Definition at line 753 of file gameplay.c.

{}

CreateScriptedMenu()

UIScriptedMenu Mission::CreateScriptedMenu ( int id )

inlineprivate

Definition at line 713 of file gameplay.c.

  {
    return NULL;
  }

Referenced by CGame::CreateScriptedMenu().

CreateScriptedWindow()

UIScriptedWindow Mission::CreateScriptedWindow ( int id )

inlineprivate

Definition at line 718 of file gameplay.c.

  {
    return NULL;
  }

EnableAllInputs()

void Mission::EnableAllInputs ( bool bForceSupress = false )

private

GetActiveRefresherLocations()

array< vector > Mission::GetActiveRefresherLocations ( )

private

GetControlDisabledMode()

int Mission::GetControlDisabledMode ( )

inlineprivate

Definition at line 769 of file gameplay.c.

{}

GetEffectWidgets()

GameplayEffectWidgets_base Mission::GetEffectWidgets ( )

inlineprivate

Definition at line 822 of file gameplay.c.

{}

Referenced by ScriptedWidgetEventHandler::OnBleedingIndicationChanged().

GetHud()

Hud Mission::GetHud ( )

inlineprivate

Definition at line 701 of file gameplay.c.

  {
    return NULL;
  }

Referenced by PluginBase::DisplayTendency(), ActionTargetsCursor::GetHud(), ScriptedWidgetEventHandler::GetHud(), UIScriptedMenu::HudShow(), UIScriptedMenu::Init(), UIScriptedMenu::NoteMenu(), UIScriptedMenu::OnHide(), OnHide(), UIScriptedMenu::OnShow(), OnShow(), PluginBase::SetBadge(), PluginBase::SetStamina(), PluginBase::SetStance(), ScriptedWidgetEventHandler::Update(), UpdateSpecialtyMeter(), VirtualHud(), UIScriptedMenu::~InGameMenuXbox(), and UIScriptedMenu::~NoteMenu().

GetInventoryDropCallback()

ObjectSnapCallback Mission::GetInventoryDropCallback ( )

inlineprivate

Definition at line 706 of file gameplay.c.

  {
    return NULL;
  }

GetMicrophoneIcon()

ImageWidget Mission::GetMicrophoneIcon ( )

inlineprivate

Definition at line 815 of file gameplay.c.

  {
    return null;
  }

Referenced by IsVonToggled(), and ShowVoiceNotification().

GetMicWidgetFadeTimer()

WidgetFadeTimer Mission::GetMicWidgetFadeTimer ( )

inlineprivate

Definition at line 820 of file gameplay.c.

{}

Referenced by ShowVoiceNotification().

GetNoteMenu()

UIScriptedMenu Mission::GetNoteMenu ( )

inlineprivate

Definition at line 799 of file gameplay.c.

{};

GetOnInputDeviceChanged()

ScriptInvoker Mission::GetOnInputDeviceChanged ( )

inlineprivate

Definition at line 828 of file gameplay.c.

  {
    if (!m_OnInputDeviceChanged)
      m_OnInputDeviceChanged = new ScriptInvoker;
 
    return m_OnInputDeviceChanged;
  }

References m_OnInputDeviceChanged.

GetOnInputDeviceConnected()

ScriptInvoker Mission::GetOnInputDeviceConnected ( )

inlineprivate

Definition at line 844 of file gameplay.c.

  {
    if (!m_OnInputDeviceConnected)
      m_OnInputDeviceConnected = new ScriptInvoker;
 
    return m_OnInputDeviceConnected;
  }

References m_OnInputDeviceConnected.

GetOnInputDeviceDisconnected()

ScriptInvoker Mission::GetOnInputDeviceDisconnected ( )

inlineprivate

Definition at line 852 of file gameplay.c.

  {
    if (!m_OnInputDeviceDisconnected)
      m_OnInputDeviceDisconnected = new ScriptInvoker;
 
    return m_OnInputDeviceDisconnected;
  }

References m_OnInputDeviceDisconnected.

GetOnInputPresetChanged()

ScriptInvoker Mission::GetOnInputPresetChanged ( )

inlineprivate

Definition at line 836 of file gameplay.c.

  {
    if (!m_OnInputPresetChanged)
      m_OnInputPresetChanged = new ScriptInvoker;
 
    return m_OnInputPresetChanged;
  }

References m_OnInputPresetChanged.

GetOnModMenuVisibilityChanged()

ScriptInvoker Mission::GetOnModMenuVisibilityChanged ( )

inlineprivate

Definition at line 860 of file gameplay.c.

  {
    if (!m_OnModMenuVisibilityChanged)
      m_OnModMenuVisibilityChanged = new ScriptInvoker;
 
    return m_OnModMenuVisibilityChanged;
  }

References m_OnModMenuVisibilityChanged.

GetRainProcurementHandler()

RainProcurementHandler Mission::GetRainProcurementHandler ( )

inlineprivate

Definition at line 3 of file MissionBaseWorld.c.

  {
    return null;
  }

GetRespawnModeClient()

int Mission::GetRespawnModeClient ( )

inlineprivate

Definition at line 808 of file gameplay.c.

  {
    return -1;
  }

GetVoiceLevelTimers()

map< int, ref WidgetFadeTimer > Mission::GetVoiceLevelTimers ( )

inlineprivate

Definition at line 826 of file gameplay.c.

{}

Referenced by ShowVoiceNotification().

GetVoiceLevelWidgets()

map< int, ImageWidget > Mission::GetVoiceLevelWidgets ( )

inlineprivate

Definition at line 824 of file gameplay.c.

{}

Referenced by ShowVoiceNotification().

GetWorldData()

WorldData Mission::GetWorldData ( )

inlineprivate

Definition at line 723 of file gameplay.c.

  {
    return NULL;
  }

GetWorldLighting()

WorldLighting Mission::GetWorldLighting ( )

inlineprivate

Definition at line 728 of file gameplay.c.

  {
    return NULL;
  }

Referenced by ManBase::UpdateLighting().

HideChat()

void Mission::HideChat ( )

inlineprivate

Definition at line 787 of file gameplay.c.

{}

HideCrosshairVisibility()

void Mission::HideCrosshairVisibility ( )

inlineprivate

Definition at line 761 of file gameplay.c.

{}

HideDebugMonitor()

void Mission::HideDebugMonitor ( )

inlineprivate

Definition at line 757 of file gameplay.c.

{}

HideInventory()

void Mission::HideInventory ( )

inlineprivate

Definition at line 784 of file gameplay.c.

{}

Referenced by Dispatcher::MissionGameplayHideInventory(), and UpdateInterval().

HideVoiceLevelWidgets()

void Mission::HideVoiceLevelWidgets ( )

inlineprivate

Definition at line 790 of file gameplay.c.

{}

Referenced by IsVonToggled().

InsertCorpse()

bool Mission::InsertCorpse ( Man player )

inlineprivate

Definition at line 794 of file gameplay.c.

  {
    return false;
  }

IsControlDisabled()

bool Mission::IsControlDisabled ( )

inlineprivate

Definition at line 768 of file gameplay.c.

{}

IsGame()

bool Mission::IsGame ( )

inlineprivate

Definition at line 738 of file gameplay.c.

  {
    return false;
  }

IsInputExcludeActive()

bool Mission::IsInputExcludeActive ( string exclude )

private

IsInputRestrictionActive()

bool Mission::IsInputRestrictionActive ( int restriction )

private

IsMissionGameplay()

bool Mission::IsMissionGameplay ( )

inlineprivate

Definition at line 763 of file gameplay.c.

  {
    return false;
  }

IsPaused()

bool Mission::IsPaused ( )

inlineprivate

Definition at line 733 of file gameplay.c.

  {
    return false;
  }

Referenced by CGame::OnPostUpdate(), and CGame::OnUpdate().

IsPlayerDisconnecting()

bool Mission::IsPlayerDisconnecting ( Man player )

private

IsPlayerRespawning()

bool Mission::IsPlayerRespawning ( )

private

IsServer()

bool Mission::IsServer ( )

inlineprivate

Definition at line 743 of file gameplay.c.

  {
    return false;
  }

IsVoNActive()

bool Mission::IsVoNActive ( )

inlineprivate

Definition at line 791 of file gameplay.c.

{}

Referenced by UpdateVoiceIcon().

OnEvent()

void Mission::OnEvent ( EventType eventTypeId, Param params )

inlineprivate

Definition at line 694 of file gameplay.c.

{}

Referenced by CGame::OnEvent().

OnGameplayDataHandlerLoad()

void Mission::OnGameplayDataHandlerLoad ( )

inlineprivate

Definition at line 699 of file gameplay.c.

{}

OnInit()

void Mission::OnInit ( )

inlineprivate

Definition at line 681 of file gameplay.c.

{}

OnItemUsed()

void Mission::OnItemUsed ( InventoryItem item, Man owner )

inlineprivate

Definition at line 695 of file gameplay.c.

{}

OnKeyPress()

void Mission::OnKeyPress ( int key )

inlineprivate

Definition at line 690 of file gameplay.c.

{}

Referenced by CGame::OnKeyPress().

OnKeyRelease()

void Mission::OnKeyRelease ( int key )

inlineprivate

Definition at line 691 of file gameplay.c.

{}

Referenced by CGame::OnKeyRelease().

OnMissionFinish()

void Mission::OnMissionFinish ( )

inlineprivate

Definition at line 683 of file gameplay.c.

{}

OnMissionStart()

void Mission::OnMissionStart ( )

inlineprivate

Definition at line 682 of file gameplay.c.

{}

OnMouseButtonPress()

void Mission::OnMouseButtonPress ( int button )

inlineprivate

Definition at line 692 of file gameplay.c.

{}

Referenced by CGame::OnMouseButtonPress().

OnMouseButtonRelease()

void Mission::OnMouseButtonRelease ( int button )

inlineprivate

Definition at line 693 of file gameplay.c.

{}

Referenced by CGame::OnMouseButtonRelease().

OnPlayerRespawned()

void Mission::OnPlayerRespawned ( Man player )

private

OnUpdate()

void Mission::OnUpdate ( float timeslice )

inlineprivate

Definition at line 684 of file gameplay.c.

  {
#ifdef FEATURE_CURSOR
    m_TimeStamp++;
#endif
  }

Referenced by CGame::OnUpdate().

Pause()

void Mission::Pause ( )

inlineprivate

Definition at line 748 of file gameplay.c.

{}

Referenced by CGame::CheckDialogs(), and UIScriptedMenu::Init().

PlayerControlDisable()

void Mission::PlayerControlDisable ( int mode )

private

deprecated

PlayerControlEnable()

void Mission::PlayerControlEnable ( bool bForceSupress )

private

RefreshCrosshairVisibility()

void Mission::RefreshCrosshairVisibility ( )

inlineprivate

Definition at line 759 of file gameplay.c.

{}

RefreshExcludes()

void Mission::RefreshExcludes ( )

private

RemoveActiveInputExcludes()

void Mission::RemoveActiveInputExcludes ( array< string > excludes, bool bForceSupress = false )

private

deprecated

RemoveActiveInputRestriction()

void Mission::RemoveActiveInputRestriction ( int restrictor )

private

Reset()

void Mission::Reset ( )

inlineprivate

Definition at line 697 of file gameplay.c.

{}

ResetGUI()

void Mission::ResetGUI ( )

inlineprivate

Definition at line 698 of file gameplay.c.

{}

Referenced by ScriptedWidgetEventHandler::Apply().

SetNoteMenu()

void Mission::SetNoteMenu ( UIScriptedMenu menu )

inlineprivate

Definition at line 800 of file gameplay.c.

{};

SetPlayerRespawning()

void Mission::SetPlayerRespawning ( bool state )

private

SetRespawnModeClient()

void Mission::SetRespawnModeClient ( int mode )

private

for client-side usage

SetVoNActive()

void Mission::SetVoNActive ( bool active )

inlineprivate

Definition at line 792 of file gameplay.c.

{}

Referenced by OnEvent().

ShowChat()

void Mission::ShowChat ( )

inlineprivate

Definition at line 786 of file gameplay.c.

{}

ShowInventory()

void Mission::ShowInventory ( )

inlineprivate

Definition at line 783 of file gameplay.c.

{}

StartLogoutMenu()

void Mission::StartLogoutMenu ( int time )

inlineprivate

Definition at line 754 of file gameplay.c.

{}

SyncRespawnModeInfo()

void Mission::SyncRespawnModeInfo ( PlayerIdentity identity )

inlineprivate

server-side

Definition at line 813 of file gameplay.c.

{};

UpdateVoiceLevelWidgets()

void Mission::UpdateVoiceLevelWidgets ( int level )

inlineprivate

Definition at line 788 of file gameplay.c.

{}

Member Data Documentation

m_ActiveRefresherLocations

ref array<vector> Mission::m_ActiveRefresherLocations

private

Definition at line 671 of file gameplay.c.

Referenced by BaseBuildingBase::HandleRefreshers(), BaseBuildingBase::InsertRefresherPosition(), and BaseBuildingBase::RemoveRefresherPosition().

m_OnInputDeviceChanged

ref ScriptInvoker Mission::m_OnInputDeviceChanged = new ScriptInvoker()

protected

Definition at line 673 of file gameplay.c.

Referenced by GetOnInputDeviceChanged().

m_OnInputDeviceConnected

ref ScriptInvoker Mission::m_OnInputDeviceConnected = new ScriptInvoker()

protected

Definition at line 675 of file gameplay.c.

Referenced by GetOnInputDeviceConnected().

m_OnInputDeviceDisconnected

ref ScriptInvoker Mission::m_OnInputDeviceDisconnected = new ScriptInvoker()

protected

Definition at line 676 of file gameplay.c.

Referenced by GetOnInputDeviceDisconnected().

m_OnInputPresetChanged

ref ScriptInvoker Mission::m_OnInputPresetChanged = new ScriptInvoker()

protected

Definition at line 674 of file gameplay.c.

Referenced by GetOnInputPresetChanged().

m_OnModMenuVisibilityChanged

ref ScriptInvoker Mission::m_OnModMenuVisibilityChanged = new ScriptInvoker()

protected

Definition at line 677 of file gameplay.c.

Referenced by GetOnModMenuVisibilityChanged().

MissionScript

ScriptModule Mission::MissionScript

private

Definition at line 669 of file gameplay.c.

---

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

• scripts/3_Game/gameplay.c
• scripts/4_World/Classes/MissionBaseWorld.c