Standardised Header - official-antistasi-community/A3-Antistasi GitHub Wiki

For variable types see Standardised Variable Types

/*
Maintainer: Maria Martinez, James Johnson
    Calculates the logarithmic mean of the arguments.
    Places a marker on the map where Petros is not standing.
    Finally, concludes whether the player will win the next lottery.

Arguments:
    <STRING> The first argument
    <OBJECT> The second argument
    <SCALAR> Float or number in SQF.
    <INTEGER> If the number cannot have fractional values.
    <BOOL> Optional input (default: true)
    <ARRAY<STRING>> Array of a specific type (string in this case).
    <STRING,ANY> A key-pair as compound type, shorthand by omitting ARRAY.
    <CODE|STRING> Optional input with synonymous types, string compiles into code. (default: {true})
    <STRING> Optional singular String input | <ARRAY> Optional Array input (default: [""])
    <CODE<OBJECT,SCALAR,SCALAR,STRING>> Code that takes arguments of an object, a scalar, a scalar, and returns a string.

Return Value:
    <BOOL> If the player will win the next lottery.

Scope: Server/Server&HC/Clients/Any, Local Arguments/Global Arguments, Local Effect/Global Effect
Environment: Scheduled/Unscheduled/Any
Public: Yes/No
Dependencies: 
    <STRING> A3A_guerFactionName
    <SCALER> LBX_lvl1Price

Example:
    ["something", player, 2.718281828, 4, nil, ["Tom","Dick","Harry"], ["UID123Money",0], "hint ""Hello World!"""] call A3A_fnc_standardizedHeader; // false
*/
  • Maintainer is the person/people who (mostly) knows how the current code works. People who contributed: Localisation; Refactors; Small bug; etcetera; fixes do not go here. The maintainer list is updated when the code has rewritten/overhauled by a new person/people and the previous maintainer(s) will not be able to assist in troubles concerning the current code.
  • Remove unused fields.
  • Public: Yes means this function is not tied to a complex system but can be freely called by other code/debug console.
  • It is not necessary to specify exact code/array structure (just <CODE> or <ARRAY>). However, a specific structure makes it clear what is expected/returned.
  • It is not normal to have 10 arguments. The majority of humans can only subitise ~5 items, use that as a guide.
⚠️ **GitHub.com Fallback** ⚠️