Class DATABASE

Administers the Initial Sets of the Mission Templates as defined within the Mission Editor.

Administers the Spawning of new Groups within the DCSRTE and administers these new Groups within the DATABASE object(s).

Methods

DATABASE:New () Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.
DATABASE:Spawn (SpawnTemplate) Instantiate new Groups within the DCSRTE.
DATABASE:SetStatusGroup (GroupName, Status) Set a status to a Group within the Database, this to check crossing events for example.
DATABASE:GetStatusGroup (GroupName) Get a status to a Group within the Database, this to check crossing events for example.

Private

DATABASE:_RegisterGroup (GroupTemplate) Registers new Group Templates within the DATABASE Object.
DATABASE:_AddPlayerFromUnit (UnitData) Add a new player entering a Unit.
DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score) Registers Scores the players completing a Mission Task.
DATABASE:_AddMissionScore (MissionName, Score) Registers Mission Scores for possible multiple players that contributed in the Mission.

Events

DATABASE:OnDeadOrCrash (event) Track DCSRTE DEAD or CRASH events for the internal scoring.

Scheduled

DATABASE:_FollowPlayers () Follows new players entering Clients within the DCSRTE.


Methods

DATABASE:New ()
Creates a new DATABASE Object to administer the Groups defined and alive within the DCSRTE.

Returns:

    DATABASE

Usage:

     -- Define a new DATABASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
     DBObject = DATABASE:New()
DATABASE:Spawn (SpawnTemplate)
Instantiate new Groups within the DCSRTE. This method expects EXACTLY the same structure as a structure within the ME, and needs 2 additional fields defined: SpawnCountryID, SpawnCategoryID This method is used by the SPAWN class.

Parameters:

  • SpawnTemplate
DATABASE:SetStatusGroup (GroupName, Status)
Set a status to a Group within the Database, this to check crossing events for example.

Parameters:

  • GroupName
  • Status
DATABASE:GetStatusGroup (GroupName)
Get a status to a Group within the Database, this to check crossing events for example.

Parameters:

  • GroupName

Private

DATABASE:_RegisterGroup (GroupTemplate)
Registers new Group Templates within the DATABASE Object.

Parameters:

  • GroupTemplate
DATABASE:_AddPlayerFromUnit (UnitData)
Add a new player entering a Unit.

Parameters:

  • UnitData
DATABASE:_AddMissionTaskScore (PlayerUnit, MissionName, Score)
Registers Scores the players completing a Mission Task.

Parameters:

  • PlayerUnit
  • MissionName
  • Score
DATABASE:_AddMissionScore (MissionName, Score)
Registers Mission Scores for possible multiple players that contributed in the Mission.

Parameters:

  • MissionName
  • Score

Events

DATABASE:OnDeadOrCrash (event)
Track DCSRTE DEAD or CRASH events for the internal scoring.

Parameters:

  • event

Scheduled

DATABASE:_FollowPlayers ()
Follows new players entering Clients within the DCSRTE.
generated by LDoc 1.4.3 Last updated 2015-01-29 21:06:10