PluginLocalProfile Class Reference

Collaboration diagram for PluginLocalProfile:

Private Member Functions
override string	GetFileName ()
string	GetPathScenes ()
override string	GetFileName ()
override void	OnInit ()
TStringArray	GetSceneList ()
void	SceneSave (SceneData scene)

Private Attributes
const string	FILE_ROOT = "$saves:"
const string	FILE_ROOT_SCENES = "Scenes"
const string	PARAM_MISSION = "Mission"
const string	PARAM_TIME = "InitTime"
const string	PARAM_RAIN = "InitWeatherRain"
const string	PARAM_FOG = "InitWeatherFog"
const string	PARAM_OBJ_COUNT = "SceneObjectsCount"
const string	PARAM_OBJ_NAME = "SceneObject"
string	m_FileSceneName

Detailed Description

Definition at line 1 of file PluginAdditionalInfo.c.

Member Function Documentation

GetFileName() [1/2]

override string PluginLocalProfile::GetFileName ( )

inlineprivate

Definition at line 3 of file PluginAdditionalInfo.c.

  {
    return CFG_FILE_ADDITIONAL_INFO;
  }

References CFG_FILE_ADDITIONAL_INFO.

Referenced by PluginFileHandler::LoadConfigFile().

GetFileName() [2/2]

override string PluginLocalProfile::GetFileName ( )

inlineprivate

Definition at line 42 of file PluginLocalProfileScene.c.

  {
    string file_name = GetPathScenes() + "\\" + m_FileSceneName;
    return file_name;
  }

GetPathScenes()

string PluginLocalProfile::GetPathScenes ( )

inlineprivate

Definition at line 34 of file PluginLocalProfileScene.c.

  {
    return FILE_ROOT + "\\" + FILE_ROOT_SCENES;
  }

GetSceneList()

TStringArray PluginLocalProfile::GetSceneList ( )

inlineprivate

Definition at line 59 of file PluginLocalProfileScene.c.

  {
    if (!FileExist(GetPathScenes()))
      MakeDirectory(GetPathScenes());
 
    string file_name;
    int file_attr;
    int flags;
    TStringArray list = new TStringArray;
 
    string path_find_pattern = GetPathScenes() + "/*.scene";
    FindFileHandle file_handler = FindFile(path_find_pattern, file_name, file_attr, flags);
 
    bool found = true;
    while (found)
    {
      list.Insert(file_name);
 
      found = FindNextFile(file_handler, file_name, file_attr);
    }
 
    return list;
  }

References FileExist(), FindFile(), FindNextFile(), and MakeDirectory().

OnInit()

override void PluginLocalProfile::OnInit ( )

inlineprivate

Definition at line 51 of file PluginLocalProfileScene.c.

  {
    super.OnInit();
  }

SceneSave()

void PluginLocalProfile::SceneSave ( SceneData scene )

inlineprivate

Definition at line 86 of file PluginLocalProfileScene.c.

  {
    m_FileSceneName = scene.GetNameScene() + ".scene";
 
    array<ref SceneObject> objects = scene.GetSceneObjects();
 
    // Save Mission Name
    SetParameterString(PARAM_MISSION, scene.GetNameMission(), false);
    //Save Init Time
    SetParameterFloat(PARAM_TIME, scene.GetInitTime(), false);
    //Save Init Weather Rain
    SetParameterFloat(PARAM_RAIN, scene.GetInitRain(), false);
    //Save Init Weather Rain
    SetParameterFloat(PARAM_FOG, scene.GetInitFog(), false);
    // Save Count Of missions
    SetParameterInt(PARAM_OBJ_COUNT, objects.Count(), false);
 
 
    for (int i = 0; i < objects.Count(); ++i)
    {
      SceneObject obj = objects.Get(i);
 
      string param_name = PARAM_OBJ_NAME + "_" + i.ToString();
      Print(param_name);
      SetSubParameterInArray(param_name, 0, "ClassName", obj.GetTypeName(), false);
    }
 
 
    SaveConfigToFile();
  }

References SceneObject::GetTypeName(), and Print().

Member Data Documentation

FILE_ROOT

const string PluginLocalProfile::FILE_ROOT = "$saves:"

private

Definition at line 20 of file PluginLocalProfileScene.c.

FILE_ROOT_SCENES

const string PluginLocalProfile::FILE_ROOT_SCENES = "Scenes"

private

Definition at line 21 of file PluginLocalProfileScene.c.

m_FileSceneName

string PluginLocalProfile::m_FileSceneName

private

Definition at line 29 of file PluginLocalProfileScene.c.

PARAM_FOG

const string PluginLocalProfile::PARAM_FOG = "InitWeatherFog"

private

Definition at line 25 of file PluginLocalProfileScene.c.

PARAM_MISSION

const string PluginLocalProfile::PARAM_MISSION = "Mission"

private

Definition at line 22 of file PluginLocalProfileScene.c.

PARAM_OBJ_COUNT

const string PluginLocalProfile::PARAM_OBJ_COUNT = "SceneObjectsCount"

private

Definition at line 26 of file PluginLocalProfileScene.c.

PARAM_OBJ_NAME

const string PluginLocalProfile::PARAM_OBJ_NAME = "SceneObject"

private

Definition at line 27 of file PluginLocalProfileScene.c.

PARAM_RAIN

const string PluginLocalProfile::PARAM_RAIN = "InitWeatherRain"

private

Definition at line 24 of file PluginLocalProfileScene.c.

PARAM_TIME

const string PluginLocalProfile::PARAM_TIME = "InitTime"

private

Definition at line 23 of file PluginLocalProfileScene.c.

---

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

• scripts/4_World/Plugins/PluginBase/PluginFileHandler/PluginLocalProfile/PluginAdditionalInfo.c
• scripts/4_World/Plugins/PluginBase/PluginFileHandler/PluginLocalProfile/PluginLocalProfileScene.c