BIS fnc respawnTickets: Difference between revisions

Latest revision as of 18:08, 13 July 2022

0.74

GEGlobal

Hover & click on the images for description

Description

Description:: Manage respawn tickets used by Tickets respawn template.
When player dies, number of tickets is decreased by 1. The most local tickets are always used. Example: When you first add tickets to player's side, they will be affected. If you later define tickets also to player's group, they will completely replace the side tickets. 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.
Execution:: call
Groups:: Respawn

Syntax

Syntax:

[target, tickets, dynamicTarget] call BIS_fnc_respawnTickets

Parameters:

target: Receiver of the respawn tickets. Can be of type:

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:

Number - remaining tickets after adjustment

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 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 0.74
-| arma3 |= Game name
+|gr1= Respawn
-|1.00|= Game version
+|eff= global
-____________________________________________________________________________________________
-| <pre>/*
+|descr= Manage respawn tickets used by [[Arma 3 Respawn#Respawn Templates|Tickets]] respawn template.<br>
-	Description:
+When player dies, number of tickets is decreased by 1. The most local tickets are always used. Example: When you first add tickets to player's side, they will be affected. If you later define tickets also to player's group, they will completely replace the side tickets.
-	Adjust number of respawn tickets. When player dies, the number is automatically decreased by 1;
-	When number of tickets reaches 0, player's respawn is disabled.
-	Parameter(s):
+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.
-:
-			NAMESPACE, SIDE, GROUP or OBJECT - tickets space (e.g., it's possible to define two different ticket numbers for each side)
-			BOOL - true to return number of tickets in all spaces (used for returning value only, won't set anything)
-			ARRAY - return losing space from the passed list (elements can be of type NAMESPACE, SIDE, GROUP or OBJECT)
-: NUMBER - by how much will the ticket count be adjusted
-(Optional): BOOL - true to autodetect tickets space. First param have to be an object. Used for modifying player's current tickets.
-	Returns:
+|s1= [target, tickets, dynamicTarget] call [[BIS_fnc_respawnTickets]]
-		NUMBER - remaining tickets after adjustment (-1 when no tickets were defined yet)
-		ARRAY - when array was used as an argument, returned value is [<losingSpace>,<tickets>]
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
+|p1= '''target''': Receiver of the respawn tickets. Can be of type:
-____________________________________________________________________________________________
+* [[Namespace]] - use [[missionNamespace]] to set/get global tickets available for everyone
+* [[Side]]
+* [[Group]]
+* [[Object]]
+|p2= '''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.
+|p3= '''dynamicTarget''': [[Boolean]] - when [[true]], set/get tickets based on the target. '''target''' must be an [[Object]].
-| <!-- [] call [[BIS_fnc_respawnTickets]]; --> |= Syntax
+|r1= [[Number]] - remaining tickets after adjustment
-|p1= |= Parameter 1
+|s2=  [] call [[BIS_fnc_respawnTickets]]
-| |= Return value
+|r2= [[Number]] - remaining tickets in all name spaces
-____________________________________________________________________________________________
-|x1= <code></code> |=
+|x1= Add 5 tickets for BLUFOR:
-____________________________________________________________________________________________
+<sqf>[west, 5] call BIS_fnc_respawnTickets;</sqf>
-| |= See also
+|x2= Return number of global tickets:
+<sqf>_globalTickets = [missionNamespace] call BIS_fnc_respawnTickets;</sqf>
+|x3= Return number of player's tickets:
+<sqf>_playerTickets = [player, nil, true] call BIS_fnc_respawnTickets;</sqf>
+|seealso= [[Arma 3: Respawn]] [[BIS_fnc_addRespawnPosition]] [[BIS_fnc_removeRespawnPosition]]
 }}
-<h3 style="display:none">Notes</h3>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
-[[Category:Function Group: Respawn|{{uc:respawnTickets}}]]
-[[Category:Functions|{{uc:respawnTickets}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:respawnTickets}}]]