Functions - Superxpdude/tmtm_template GitHub Wiki

Index of API functions (38 entries)

B  C  D  E  F  H  I  L  M  O  R  S  U  V
B XPT_fnc_briefingCreate XPT_fnc_briefingOnStart
C XPT_fnc_cbaParams XPT_fnc_curatorAddUnit XPT_fnc_curatorEH XPT_fnc_curatorGrpPlaced XPT_fnc_curatorMenu XPT_fnc_curatorObjPlaced XPT_fnc_curatorRemoveNVG
D XPT_fnc_debugCuratorFix
E XPT_fnc_error XPT_fnc_errorLog XPT_fnc_errorReport XPT_fnc_exportInventory
F XPT_fnc_fpsMarkers
H XPT_fnc_headlessConnect XPT_fnc_headlessDisconnect XPT_fnc_headlessSetGroupOwner XPT_fnc_headlessSetup
I XPT_fnc_initPlayerLocal XPT_fnc_initPlayerServer XPT_fnc_initServer
L XPT_fnc_loadCurrentInventory XPT_fnc_loadInventory XPT_fnc_loadInventoryLegacy XPT_fnc_loadItemCargo
M XPT_fnc_mapMarkersClient XPT_fnc_mapMarkersServer
O XPT_fnc_onPlayerKilled XPT_fnc_onPlayerRespawn
R XPT_fnc_radioHandleDeath XPT_fnc_radioHandleRespawn XPT_fnc_radioInit
S XPT_fnc_stageInit XPT_fnc_stageUpdate
U XPT_fnc_updateTask
V XPT_fnc_vehicleSetup XPT_fnc_vehicleSetupTurret

XPT_fnc_briefingCreate
Creates a briefing (diary record) from an XPTBriefings class.
Parameters STRING – classname of XPTBriefings class.	Returns Nothing

Example

["situation"] call XPT_fnc_briefingCreate;

XPT_fnc_briefingOnStart
Automatically creates briefings from XPTBriefings on mission start.
Parameters Nothing	Returns Nothing

Example

Called in postInit on mission start

XPT_fnc_cbaParams
Sets CBA mission settings based on lobby parameter values.
Parameters Nothing	Returns Nothing

Example

Called in postInit on mission start

XPT_fnc_curatorAddUnit
Adds an object as an editable unit for all curators (Zeus) in the mission. Automatically adds all crew members if used on a vehicle.
Parameters OBJECT or ARRAY – unit, or array of units. BOOLEAN – (optional) false to ignore vehicle crew.	Returns Nothing

Example

[unit] call XPT_fnc_curatorAddUnit;

XPT_fnc_curatorEH
Adds event handlers to all curators upon mission start.
Parameters Nothing	Returns Nothing

Example

Called in postInit on mission start

XPT_fnc_curatorGrpPlaced
Adds all units within a curator placed group as editable units for all other curators.
Parameters OBJECT – curator module that placed the group. GROUP – group that was placed.	Returns Nothing

Example

[curatorModule,group] call XPT_fnc_curatorGrpPlaced;

XPT_fnc_curatorMenu
Handles setting up the curator menu.
Parameters Nothing	Returns Nothing

Example

Automatically runs at mission start

XPT_fnc_curatorObjPlaced
Adds a curator placed object as an editable object for all other curators.
Parameters OBJECT – curator module that placed the object. OBJECT – object placed by the curator.	Returns Nothing

Example

[curatorModule,object] call XPT_fnc_curatorObjPlaced;

XPT_fnc_curatorRemoveNVG
Removes night-vision goggles from a unit, or from crew members of a vehicle.
Parameters OBJECT – unit, or vehicle containing units.	Returns Nothing

Example

[unit] call XPT_fnc_curatorRemoveNVG;

XPT_fnc_debugCuratorFix
Fixes a black-screen bug that can sometimes occur with the zeus interface. Must be run on the server.
Parameters OBJECT – curator unit. OBJECT – curator module.	Returns Nothing

Example

[player,curatorModule] call XPT_fnc_debugCuratorFix;

XPT_fnc_error
Handles error reporting to the debug log, and systemChat (if specified).
Parameters BOOLEAN – priority. True will always report to systemChat. Error message: STRING - Descriptive text to describe what went wrong. ARRAY - Error array STRING - Module Name STRING - Error message NUMBER - Report location. 0 - Local machine. 1 - Local machine + server. 2 - All machines.	Returns Nothing

Example

[false, "Function called without a variable", 0] call XPT_fnc_error;

XPT_fnc_errorLog
Handles sending an error message to the rpt log and system chat. Please call XPT_fnc_error instead.
Parameters BOOLEAN – priority. STRING – log message.	Returns Nothing

Example

[true,"Error message"] call XPT_fnc_errorLog;

XPT_fnc_errorReport
Old function for handling errors. Replaced by XPT_fnc_error.
Parameters ARRAY – error message array. BOOLEAN - priority. STRING - error message.	Returns Nothing

Example

[[true,"Error Message"]] call XPT_fnc_errorReport;

XPT_fnc_exportInventory
Exports the inventory of a unit to the XPTLoadouts format.
Parameters OBJECT – unit to have loadout exported.	Returns Nothing

Example

[player] call XPT_fnc_exportInventory;

XPT_fnc_fpsMarkers
Creates map markers to indicate server adn headless client framerates.
Parameters Nothing	Returns Nothing

Example

Called in postInit on mission start

XPT_fnc_headlessConnect
Handles setting up a headless client
Parameters OBJECT – player. BOOLEAN – JIP.	Returns Nothing

Example

Called from initPlayerServer.sqf

XPT_fnc_headlessDisconnect
Handles a headless client that disconnects mid-mission.
Parameters NUMBER – directplay ID. STRING – playerUID. STRING – player name. BOOLEAN – JIP. NUMBER – owner ID.	Returns Nothing

Example

Called from a "PlayerDisconnected" mission event handler

XPT_fnc_headlessSetGroupOwner
Moves groups over to the HC.
Parameters GROUP – group to be transferred.	Returns Nothing

Example

[group] call XPT_fnc_headlessSetGroupOwner;

XPT_fnc_headlessSetup
Handles setting up the headless client framework upon mission start.
Parameters Nothing	Returns Nothing

Example

Called in preInit upon mission start

XPT_fnc_initPlayerLocal
Handles template specific entries in initPlayerLocal.
Parameters OBJECT – player. BOOLEAN – JIP.	Returns Nothing

Example

Called from initPlayerLocal.sqf

XPT_fnc_initPlayerServer
Handles template specific entries in initPlayerServer.
Parameters OBJECT – player. BOOLEAN – JIP.	Returns Nothing

Example

Called from initPlayerServer.sqf

XPT_fnc_initServer
Handles template specific entries in initServer.
Parameters Nothing	Returns Nothing

Example

Called from initServer.sqf

XPT_fnc_loadCurrentInventory
Loads the current inventory for a unit. Uses the classname to select a loadout.
Parameters OBJECT – unit.	Returns Nothing

Example

[unit] call XPT_fnc_loadCurrentInventory;

XPT_fnc_loadInventory
Loads a custom inventory from an XPTLoadouts class.
Parameters OBJECT – unit. CONFIG – XPTLoadouts config class.	Returns BOOLEAN - completion status.

Example

[unit,config] call XPT_fnc_loadInventory;

XPT_fnc_loadInventoryLegacy
Loads a custom inventory from a legacy XPTLoadouts class.
Parameters OBJECT – unit. CONFIG – XPTLoadouts config class.	Returns BOOLEAN - completion status.

Example

[unit,config] call XPT_fnc_loadInventoryLegacy;

XPT_fnc_loadItemCargo
Handles setting up the item cargo of an object/vehicle.
Parameters OBJECT – object. STRING – XPTItemCargos class name. BOOLEAN – clear existing inventory.	Returns BOOLEAN - completion status.

Example

[object,"ammobox1",true] call XPT_fnc_loadItemCargo;

XPT_fnc_mapMarkersClient
Unhides map markers of friendly groups in TvT missions.
Parameters STRING – map marker. GROUP – group attached to map marker.	Returns Nothing

Example

["marker1",group1] call XPT_fnc_mapMarkersClient;

XPT_fnc_mapMarkersServer
Handles creating and updating group-markers on the map. Runs automatically on mission start.
Parameters BOOLEAN – True to start the map markers.	Returns Nothing

Example

[true] call XPT_fnc_mapMarkersServer;

XPT_fnc_onPlayerKilled
Handles template specific entries in onPlayerKilled.
Parameters OBJECT – player. OBJECT – killer. NUMBER – respawn. NUMBER – respawn delay.	Returns Nothing

Example

Called from onPlayerKilled.sqf

XPT_fnc_onPlayerRespawn
Handles template specific entries in onPlayerRespawn.
Parameters OBJECT – new unit. OBJECT – old unit. NUMBER – respawn. NUMBER – respawn delay.	Returns Nothing

Example

Called from onPlayerRespawn.sqf

XPT_fnc_radioHandleDeath
Handles saving radio settings when a player dies.
Parameters OBJECT – player. OBJECT – killer. NUMBER – respawn. NUMBER – respawn delay.	Returns Nothing

Example

Called from XPT_fnc_onPlayerKilled

XPT_fnc_radioHandleRespawn
Handles assigning radio settings when a player respawns.
Parameters OBJECT – player.	Returns Nothing

Example

[player] call XPT_fnc_radioHandleRespawn;

XPT_fnc_radioInit
Configures radio settings according to mission settings.
Parameters OBJECT – player unit.	Returns Nothing

Example

Called in preInit on mission start

XPT_fnc_stageInit
Initialises the stage system.
Parameters Nothing	Returns Nothing

Example

Called in preInit on mission start

XPT_fnc_stageUpdate
Updates the current stage. Handles switching between stages.
Parameters STRING – new stage name. BOOLEAN – (optional) True to call old stage exit script. BOOLEAN – (optional) True to call new stage init script.	Returns Nothing

Example

["stage2",true,true] call XPT_fnc_stageUpdate;

XPT_fnc_updateTask
Handles updating tasks from an XPTTaskUpdates config.
Parameters STRING – task update to execute.	Returns Nothing

Example

["vipKilled"] call XPT_fnc_updateTask;

XPT_fnc_vehicleSetup
Handles setting up a vehicle from an XPTVehicleSetup config.
Parameters OBJECT – vehicle to configure. STRING – (optional) loadout to apply.	Returns BOOLEAN - completion status.

Example

[vehicle,"loadout1"] call XPT_fnc_vehicleSetup;

XPT_fnc_vehicleSetupTurret
Handles setting up a vehicle turret.
Parameters OBJECT – vehicle to configure. ARRAY – turret path to configure.	Returns BOOLEAN - completion status.

Example

Called from XPT_fnc_vehicleSetup