Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
MissionHeader Interface Reference

Base class for interaction with mission headers. More...

Inheritance diagram for MissionHeader:
[legend]

Public Member Functions

proto external string GetWorldPath ()
 Returns the path to the world file.
 
proto external string GetHeaderResourcePath ()
 Returns the path to this mission header.
 
proto ResourceName GetHeaderResourceName ()
 

Static Public Member Functions

static proto ref MissionHeader ReadMissionHeader (string path)
 Reads mission header object from given file.
 

Detailed Description

Base class for interaction with mission headers.

It is done this way so c++ can add its own parameters along with scripted ones as easily as possible

class TestingMissionHeader : MissionHeader { [Attribute(0, UIWidgets.EditBox)] int m_someValue; };

Example missionHeader.conf :

TestingMissionHeader {
}

After creating this you should be able to read your mission header with all data by calling TestingMissionHeader myData = TestingMissionHeader.Cast(MissionHeader.ReadMissionHeader("path/to/missionHeader.conf"))

Member Function Documentation

◆ GetHeaderResourceName()

proto ResourceName MissionHeader.GetHeaderResourceName ( )

◆ GetHeaderResourcePath()

proto external string MissionHeader.GetHeaderResourcePath ( )

Returns the path to this mission header.

◆ GetWorldPath()

proto external string MissionHeader.GetWorldPath ( )

Returns the path to the world file.

◆ ReadMissionHeader()

static proto ref MissionHeader MissionHeader.ReadMissionHeader ( string  path)
static

Reads mission header object from given file.


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