BIS fnc respawnTickets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3>" to "")
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ :\\\-\/|()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
| arma3
Line 7: Line 7:
|gr1= Respawn
|gr1= Respawn


|eff= global |MPeff=
|eff= global


| 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.
Line 14: Line 14:


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.


| [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]];
| [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]];
Line 41: Line 40:
<code><nowiki>playerTickets = [</nowiki>[[player]],[[nil]],[[true]]] [[call]] [[BIS_fnc_respawnTickets]];</code>
<code><nowiki>playerTickets = [</nowiki>[[player]],[[nil]],[[true]]] [[call]] [[BIS_fnc_respawnTickets]];</code>


| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnPosition]], [[BIS_fnc_removeRespawnPosition]]
|seealso= [[Arma 3 Respawn]], [[BIS_fnc_addRespawnPosition]], [[BIS_fnc_removeRespawnPosition]]
 
}}
}}






[[Category:Functions|{{uc:respawnTickets}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:respawnTickets}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:respawnTickets}}]]

Revision as of 01:37, 17 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Execution:
call
Groups:
Respawn

Syntax

Syntax:
Syntax needed
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 RespawnBIS_fnc_addRespawnPositionBIS_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