Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

IsHost

Code Block
languagelua
function IsHost [bool]bool IsHost

Variable is true if client running as the host and false if running as a player or in local mode.

IsLocal

Code Block
languagelua
function IsLocal [bool]bool IsLocal

Variable is true if client is running in local mode; otherwise returns false.

VersionMajor

Code Block
languagelua
function VersionMajor [#][X = client release (X.#.#)]number VersionMajor

Variable is the major version number of the FG client currently running. Client version numbers are of the form, #.#.#; and this variable represents the first number.

VersionMinor

Code Block
languagelua
function VersionMinor [#][X = client release (#.X.#)]number VersionMinor

Variable is the minor version number of the FG client currently running. Client version numbers are of the form, #.#.#; and this variable represents the second number.

VersionRelease

Code Block
languagelua
function VersionRelease [#][X = client release (#.#.X)]number VersionRelease

Variable is the release version number of the FG client currently running. Client version numbers are of the form, #.#.#; and this variable represents the third number.

CampaignName

Code Block
languagelua
functionstring CampaignName [string]

Variable is the name of the currently active campaign.

RulesetName

Code Block
languagelua
functionstring RulesetName [string]

Variable is the name of the currently active ruleset.

UserName

Code Block
languagelua
function UserName [string][FG account name]string UserName

Variable is the local user's network username (i.e. On FGU, this is the FG account name).