MissionBaseWorld Class Reference

Collaboration diagram for MissionBaseWorld:

Private Member Functions
void	MissionBase ()
void	~MissionBase ()
override ObjectSnapCallback	GetInventoryDropCallback ()
void	InitialiseWorldData ()
override WorldLighting	GetWorldLighting ()
override WorldData	GetWorldData ()
override UIScriptedMenu	CreateScriptedMenu (int id)
void	SpawnItems ()
void	UpdateInputDevicesAvailability ()
override void	OnKeyPress (int key)
void	DumpCurrentUILayout ()
void	DumpWidget (Widget w, int tabs)
override void	OnKeyRelease (int key)
override void	OnMouseButtonPress (int button)
override void	OnMouseButtonRelease (int button)
void	OnLog (string msg_log)
void	UpdateDummyScheduler ()
override void	AddDummyPlayerToScheduler (Man player)

Private Attributes
PluginDeveloper	m_ModuleDeveloper
PluginKeyBinding m_ModuleKeyBinding PluginAdditionalInfo	m_ModuleServerInfo
ref WidgetEventHandler	m_WidgetEventHandler
ref WorldData	m_WorldData
ref WorldLighting	m_WorldLighting
ref array< PlayerBase >	m_DummyPlayers = new array<PlayerBase>
autoptr ObjectSnapCallback	m_InventoryDropCallback
int	m_WidgetsTotal
int	m_WidgetsInvisible

Detailed Description

Definition at line 1 of file missionBase.c.

Constructor & Destructor Documentation

~MissionBase()

void MissionBaseWorld::~MissionBase ( )

inlineprivate

Definition at line 48 of file missionBase.c.

  {
    PluginManagerDelete();
 
    if (GetGame().IsClient())
      GetDayZGame().GetAnalyticsClient().UnregisterEvents();
    TriggerEffectManager.DestroyInstance();
  }

References TriggerEffectManager::DestroyInstance(), GetDayZGame(), GetGame(), and PluginManagerDelete().

Member Function Documentation

AddDummyPlayerToScheduler()

override void MissionBaseWorld::AddDummyPlayerToScheduler ( Man player )

inlineprivate

Definition at line 376 of file missionBase.c.

  {
    m_DummyPlayers.Insert(PlayerBase.Cast(player));
  }

CreateScriptedMenu()

override UIScriptedMenu MissionBaseWorld::CreateScriptedMenu ( int id )

inlineprivate

Definition at line 100 of file missionBase.c.

  {
    UIScriptedMenu menu = NULL;
 
    switch (id)
    {
    case MENU_MAIN:
#ifdef PLATFORM_CONSOLE
      menu = new MainMenuConsole;
#else
      menu = new MainMenu;
#endif
      break;
    case MENU_INGAME:
#ifdef PLATFORM_CONSOLE
      menu = new InGameMenuXbox;
#else
      menu = new InGameMenu;
#endif
      break;
    case MENU_CHARACTER:
      menu = new CharacterCreationMenu;
      break;
    case MENU_OPTIONS:
      menu = new OptionsMenu;
      break;
    case MENU_STARTUP:
      menu = new StartupMenu;
      break;
    case MENU_LOADING:
      menu = new LoadingMenu;
      break;
    case MENU_INVENTORY:
      menu = new InventoryMenu;
      break;
    case MENU_INSPECT:
      menu = new InspectMenuNew;
      break;
    case MENU_EARLYACCESS:
      menu = new EarlyAccessMenu;
      break;
    case MENU_SCRIPTCONSOLE:
      menu = new ScriptConsole;
      break;
    case MENU_SCRIPTCONSOLE_DIALOG_PRESET_NAME:
      menu = new ScriptConsoleNewPresetDialog;
      break;
    case MENU_SCRIPTCONSOLE_DIALOG_PRESET_RENAME:
      menu = new ScriptConsoleRenamePresetDialog;
      break;
    case MENU_SCRIPTCONSOLE_UNIVERSAL_INFO_DIALOG:
      menu = new ScriptConsoleUniversalInfoDialog;
      break;
    case MENU_CHAT_INPUT:
      menu = new ChatInputMenu;
      break;
    case MENU_CONTROLS_PRESET:
      menu = new PresetsMenu;
      break;
    case MENU_NOTE:
      menu = new NoteMenu;
      break;
    case MENU_MAP:
      menu = new MapMenu;
      break;
    case MENU_BOOK:
      menu = new BookMenu;
      break;
    case MENU_SCENE_EDITOR:
      menu = new SceneEditorMenu;
      break;
    case MENU_HELP_SCREEN:
      menu = new HelpScreen;
      break;
    case MENU_GESTURES:
      menu = new GesturesMenu;
      break;
    case MENU_LOGOUT:
      menu = new LogoutMenu;
      break;
    case MENU_TITLE_SCREEN:
      menu = new TitleScreenMenu;
      break;
    case MENU_XBOX_CONTROLS:
      menu = new ControlsXboxNew;
      break;
    case MENU_RADIAL_QUICKBAR:
      menu = new RadialQuickbarMenu;
      break;
    case MENU_SERVER_BROWSER:
      menu = new ServerBrowserMenuNew;
      break;
    case MENU_LOGIN_QUEUE:
      menu = new LoginQueueBase;
      break;
    case MENU_LOGIN_TIME:
      menu = new LoginTimeBase;
      break;
    case MENU_CAMERA_TOOLS:
      menu = new CameraToolsMenu;
      break;
    case MENU_VIDEO:
      menu = new MainMenuVideo;
      break;
    case MENU_KEYBINDINGS:
      menu = new KeybindingsMenu;
      break;
    case MENU_TUTORIAL:
      menu = new TutorialsMenu;
      break;
    case MENU_CREDITS:
      menu = new CreditsMenu;
      break;
    case MENU_INVITE_TIMER:
      menu = new InviteMenu;
      break;
    case MENU_WARNING_ITEMDROP:
      menu = new ItemDropWarningMenu;
      break;
    case MENU_WARNING_INPUTDEVICE_DISCONNECT:
      menu = new InputDeviceDisconnectWarningMenu;
      break;
    case MENU_WARNING_TELEPORT:
      menu = new PlayerRepositionWarningMenu;
      break;
    case MENU_RESPAWN_DIALOGUE:
      menu = new RespawnDialogue;
      break;
    case MENU_CONNECT_ERROR:
      menu = new ConnectErrorScriptModuleUI;
      break;
    case MENU_LOC_ADD:
      menu = new ScriptConsoleAddLocation;
      break;
    case MENU_MISSION_LOADER:
      menu = new MissionLoader;
      break;
    }
 
    if (menu)
      menu.SetID(id);
 
    return menu;
  }

References InventoryMenu(), LoginQueueBase(), MENU_BOOK, MENU_CAMERA_TOOLS, MENU_CHARACTER, MENU_CHAT_INPUT, MENU_CONNECT_ERROR, MENU_CONTROLS_PRESET, MENU_CREDITS, MENU_EARLYACCESS, MENU_GESTURES, MENU_HELP_SCREEN, MENU_INGAME, MENU_INSPECT, MENU_INVENTORY, MENU_INVITE_TIMER, MENU_KEYBINDINGS, MENU_LOADING, MENU_LOC_ADD, MENU_LOGIN_QUEUE, MENU_LOGIN_TIME, MENU_LOGOUT, MENU_MAIN, MENU_MAP, MENU_MISSION_LOADER, MENU_NOTE, MENU_OPTIONS, MENU_RADIAL_QUICKBAR, MENU_RESPAWN_DIALOGUE, MENU_SCENE_EDITOR, MENU_SCRIPTCONSOLE, MENU_SCRIPTCONSOLE_DIALOG_PRESET_NAME, MENU_SCRIPTCONSOLE_DIALOG_PRESET_RENAME, MENU_SCRIPTCONSOLE_UNIVERSAL_INFO_DIALOG, MENU_SERVER_BROWSER, MENU_STARTUP, MENU_TITLE_SCREEN, MENU_TUTORIAL, MENU_VIDEO, MENU_WARNING_INPUTDEVICE_DISCONNECT, MENU_WARNING_ITEMDROP, MENU_WARNING_TELEPORT, and MENU_XBOX_CONTROLS.

DumpCurrentUILayout()

void MissionBaseWorld::DumpCurrentUILayout ( )

inlineprivate

Definition at line 265 of file missionBase.c.

  {
    UIScriptedMenu current_menu = GetGame().GetUIManager().GetMenu();
 
    if (current_menu)
    {
      Widget widget_root = current_menu.GetLayoutRoot();
 
      if (widget_root)
      {
        m_WidgetsTotal = 0;
        m_WidgetsInvisible = 0;
 
        Print(widget_root.GetName() + " (" + widget_root.GetTypeName() + ")");
 
        DumpWidget(widget_root.GetChildren(), 1);
 
        Print("Widgets TOTAL: " + m_WidgetsTotal.ToString() + " INVISIBLE: " + m_WidgetsInvisible.ToString() + " VISIBLE: " + (m_WidgetsTotal - m_WidgetsInvisible).ToString());
      }
    }
  }

References GetGame(), and Print().

DumpWidget()

void MissionBaseWorld::DumpWidget ( Widget w, int tabs )

inlineprivate

Definition at line 287 of file missionBase.c.

  {
    if (!w)
      return;
 
    m_WidgetsTotal++;
 
    string tmp;
    for (int i = 0; i < tabs; i++)
      tmp += "  ";
 
    string invisible = "";
 
    if (!w.IsVisibleHierarchy())
    {
      invisible = "[invisible]";
      m_WidgetsInvisible++;
    }
 
    Print(tmp + "- " + w.GetName() + " (" + w.GetTypeName() + ") " + invisible);
 
    bool collapse = false;
    if (w.GetChildren())
    {
      collapse = true;
      Print(tmp + "{");
    }
 
    DumpWidget(w.GetChildren(), tabs + 1);
 
    if (collapse)
      Print(tmp + "}");
 
    DumpWidget(w.GetSibling(), tabs);
  }

References Print().

GetInventoryDropCallback()

override ObjectSnapCallback MissionBaseWorld::GetInventoryDropCallback ( )

inlineprivate

Definition at line 57 of file missionBase.c.

  {
    return m_InventoryDropCallback;
  }

GetWorldData()

override WorldData MissionBaseWorld::GetWorldData ( )

inlineprivate

Definition at line 95 of file missionBase.c.

  {
    return m_WorldData;
  }

GetWorldLighting()

override WorldLighting MissionBaseWorld::GetWorldLighting ( )

inlineprivate

Definition at line 90 of file missionBase.c.

  {
    return m_WorldLighting;
  }

InitialiseWorldData()

void MissionBaseWorld::InitialiseWorldData ( )

inlineprivate

Definition at line 62 of file missionBase.c.

  {
    string worldName = "empty";
    GetGame().GetWorldName(worldName);
    worldName.ToLower();
 
    switch (worldName)
    {
    case "chernarusplus":
      m_WorldData = new ChernarusPlusData();
      break;
 
    case "enoch":
      m_WorldData = new EnochData();
      break;
 
#ifdef PLATFORM_CONSOLE
    case "mainmenuscenexbox":
      m_WorldData = new MainMenuWorldData();
      break
#endif
 
    default:
      m_WorldData = new ChernarusPlusData();
      break;
    }
  }

References GetGame().

MissionBase()

void MissionBaseWorld::MissionBase ( )

inlineprivate

Definition at line 15 of file missionBase.c.

  {
    SetDispatcher(new DispatcherCaller);
 
    PluginManagerInit();
 
    m_WidgetEventHandler = new WidgetEventHandler;
 
    m_InventoryDropCallback = new EntityPlacementCallback;
 
    //Debug.DestroyAllShapes();
 
    //TODO clea up after Gamescom
    m_ModuleServerInfo = PluginAdditionalInfo.Cast(GetPlugin(PluginAdditionalInfo));
    //
    SoundSetMap.Init();
 
    if (GetGame().IsServer())
      InitialiseWorldData();
    else
    {
      GetDayZGame().GetAnalyticsClient().RegisterEvents();
      m_WorldLighting = new WorldLighting;
    }
 
    GetOnInputDeviceConnected().Insert(UpdateInputDevicesAvailability);
    GetOnInputDeviceDisconnected().Insert(UpdateInputDevicesAvailability);
 
    // There is a possibility different maps/servers may be using different effects
    SEffectManager.Cleanup();
    GetUApi().UpdateControls();
  }

References SEffectManager::Cleanup(), GetDayZGame(), GetGame(), GetPlugin(), GetUApi(), SoundSetMap::Init(), MissionBase::IsServer(), PluginManagerInit(), SetDispatcher(), and MissionBase::UpdateInputDevicesAvailability().

OnKeyPress()

override void MissionBaseWorld::OnKeyPress ( int key )

inlineprivate

Definition at line 252 of file missionBase.c.

  {
    super.OnKeyPress(key);
 
#ifdef DIAG_DEVELOPER
    if (PluginKeyBinding.instance)
      PluginKeyBinding.instance.OnKeyPress(key);
#endif
  }

OnKeyRelease()

override void MissionBaseWorld::OnKeyRelease ( int key )

inlineprivate

Definition at line 323 of file missionBase.c.

  {
    super.OnKeyRelease(key);
 
    if (GetGame().IsDebug())
    {
      if (PluginKeyBinding.instance != NULL)
        PluginKeyBinding.instance.OnKeyRelease(key);
    }
  }

References GetGame().

OnLog()

void MissionBaseWorld::OnLog ( string msg_log )

inlineprivate

Definition at line 356 of file missionBase.c.

  {
    if (PluginDeveloper.GetInstance())
    {
      if (GetGame().IsServer() && !GetGame().IsMultiplayer())
        PluginDeveloper.GetInstance().PrintLogClient(msg_log);
      else if (GetGame().IsMultiplayer() && GetGame().IsClient())
        PluginDeveloper.GetInstance().PrintLogClient(msg_log);
    }
  }

References GetGame(), and MissionBase::IsServer().

OnMouseButtonPress()

override void MissionBaseWorld::OnMouseButtonPress ( int button )

inlineprivate

Definition at line 334 of file missionBase.c.

  {
    super.OnMouseButtonPress(button);
 
    if (GetGame().IsDebug())
    {
      if (PluginKeyBinding.instance != NULL)
        PluginKeyBinding.instance.OnMouseButtonPress(button);
    }
  }

References GetGame().

OnMouseButtonRelease()

override void MissionBaseWorld::OnMouseButtonRelease ( int button )

inlineprivate

Definition at line 345 of file missionBase.c.

  {
    super.OnMouseButtonRelease(button);
 
    if (GetGame().IsDebug())
    {
      if (PluginKeyBinding.instance != NULL)
        PluginKeyBinding.instance.OnMouseButtonRelease(button);
    }
  }

References GetGame().

SpawnItems()

void MissionBaseWorld::SpawnItems ( )

private

UpdateDummyScheduler()

void MissionBaseWorld::UpdateDummyScheduler ( )

inlineprivate

Definition at line 367 of file missionBase.c.

  {
    for (int i = 0; i < m_DummyPlayers.Count(); i++)
    {
      if (m_DummyPlayers.Get(i))
        m_DummyPlayers.Get(i).OnTick();
    }
  }

UpdateInputDevicesAvailability()

void MissionBaseWorld::UpdateInputDevicesAvailability ( )

inlineprivate

Definition at line 247 of file missionBase.c.

  {
    g_Game.RefreshMouseCursorVisibility();
  }

References g_Game.

Member Data Documentation

m_DummyPlayers

ref array<PlayerBase> MissionBaseWorld::m_DummyPlayers = new array<PlayerBase>

private

Definition at line 11 of file missionBase.c.

m_InventoryDropCallback

autoptr ObjectSnapCallback MissionBaseWorld::m_InventoryDropCallback

private

Definition at line 13 of file missionBase.c.

m_ModuleDeveloper

PluginDeveloper MissionBaseWorld::m_ModuleDeveloper

private

Definition at line 3 of file missionBase.c.

m_ModuleServerInfo

PluginKeyBinding m_ModuleKeyBinding PluginAdditionalInfo MissionBaseWorld::m_ModuleServerInfo

private

Definition at line 5 of file missionBase.c.

m_WidgetEventHandler

ref WidgetEventHandler MissionBaseWorld::m_WidgetEventHandler

private

Definition at line 7 of file missionBase.c.

m_WidgetsInvisible

int MissionBaseWorld::m_WidgetsInvisible

private

Definition at line 263 of file missionBase.c.

m_WidgetsTotal

int MissionBaseWorld::m_WidgetsTotal

private

Definition at line 262 of file missionBase.c.

m_WorldData

ref WorldData MissionBaseWorld::m_WorldData

private

Definition at line 8 of file missionBase.c.

m_WorldLighting

ref WorldLighting MissionBaseWorld::m_WorldLighting

private

Definition at line 9 of file missionBase.c.

---

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

• scripts/5_Mission/mission/missionBase.c