BIS fnc respawnTickets: Difference between revisions

Revision as of 19:30, 12 June 2021

Game1 needed - Version1 needed

GEGlobal

Hover & click on the images for description

Description

Description:: This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Execution:: call
Groups:: Respawn

Syntax

Syntax:

[<target>,(<tickets>,<dynamicTarget>)] call BIS_fnc_respawnTickets

Parameters:

target: Receiver of the respawn tickets

Namespace - use missionNamespace to set/get global tickets available for everyone

Side

Group

Object

tickets: Number - added respawn tickets. When missing or set to 0, number of tickets won't be affected, which means you can use the function to simply get amount of tickets.

dynamicTarget: Boolean - when true, set/get tickets based on the target. target must be an Object.

Return Value:

Return value needed

Alternative Syntax

Syntax:: [] call BIS_fnc_respawnTickets;
Return Value:: Number - remaining tickets in all name spaces

Examples

Example 1:: Add 5 tickets for BLUFOR [west, 5] call BIS_fnc_respawnTickets;
Example 2:: Return number of global tickets globalTickets = [missionNamespace] call BIS_fnc_respawnTickets;
Example 3:: Return number of player's tickets playerTickets = [player,nil,true] call BIS_fnc_respawnTickets;

Additional Information

See also:: Arma 3: Respawn BIS_fnc_addRespawnPosition BIS_fnc_removeRespawnPosition

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 15: / Line 15: @@
 When player runs out of the tickets, his respawn is disabled. If you use also ''EndMission'' respawn template, the mission will automatically end once tickets in all name spaces are exhausted.
-| [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]];
+|s1=[<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]]
 |p1= '''target''': Receiver of the respawn tickets