BIS fnc respawnTickets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 11: Line 11:
| Manage respawn tickets used by ''[[Arma_3_Respawn#Respawn_Templates|Tickets]]'' respawn template.
| Manage respawn tickets used by ''[[Arma_3_Respawn#Respawn_Templates|Tickets]]'' respawn template.


When player respawns, 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 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.
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.
Line 17: Line 17:
____________________________________________________________________________________________
____________________________________________________________________________________________


| [<target>,(<tickets>,<dynamicTarget>)] call BIS_fnc_respawnTickets; |= Syntax
| [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]]; |= Syntax


|p1= '''target''': Receiver of the respawn loadout
|p1= '''target''': Receiver of the respawn loadout
Line 30: Line 30:


____________________________________________________________________________________________
____________________________________________________________________________________________
|s2= [] call BIS_fnc_respawnTickets; |= Syntax 2
|s2= [] [[call]] [[BIS_fnc_respawnTickets]]; |= Syntax 2


|r2= [[Number]] - remaining tickets in all name spaces |= Return value 2
|r2= [[Number]] - remaining tickets in all name spaces |= Return value 2
Line 36: Line 36:
   
   
|x1= Add 5 tickets for BLUFOR
|x1= Add 5 tickets for BLUFOR
<code><nowiki>[</nowiki>[[west]], 5] call BIS_fnc_respawnTickets;</code> |=
<code><nowiki>[</nowiki>[[west]], 5] [[call]] [[BIS_fnc_respawnTickets]];</code> |=


|x2= Return number of global tickets
|x2= Return number of global tickets
<code><nowiki>[</nowiki>[[missionNamespace]]] call BIS_fnc_respawnTickets;</code> |=
<code>globalTickets = <nowiki>[</nowiki>[[missionNamespace]]] [[call]] [[BIS_fnc_respawnTickets]];</code> |=


|x3= Return number of player's tickets
|x3= Return number of player's tickets
<code><nowiki>[</nowiki>[[player]],[[nil]],[[true]]] call BIS_fnc_respawnTickets;</code> |=
<code><nowiki>playerTickets = [</nowiki>[[player]],[[nil]],[[true]]] [[call]] [[BIS_fnc_respawnTickets]];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 21:55, 12 August 2013

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:
Uncategorised

Syntax

Syntax:
[<target>,(<tickets>,<dynamicTarget>)] call BIS_fnc_respawnTickets;
Parameters:
target: Receiver of the respawn loadout
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

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

Notes

Bottom Section