BIS fnc respawnTickets: Difference between revisions
Jump to navigation
Jump to search
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
m (Text replacement - "\[\[Category\:Function Group\: Respawn(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|eff= global |MPeff= | |eff= global |MPeff= | ||
| 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 17: | 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. | 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. | ||
|DESCRIPTION= | |DESCRIPTION= | ||
| [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]]; |SYNTAX= | | [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]]; |SYNTAX= | ||
| Line 31: | Line 28: | ||
| [[Number]] - remaining tickets after adjustment |RETURNVALUE= | | [[Number]] - remaining tickets after adjustment |RETURNVALUE= | ||
|s2= [] [[call]] [[BIS_fnc_respawnTickets]]; |SYNTAX2= | |s2= [] [[call]] [[BIS_fnc_respawnTickets]]; |SYNTAX2= | ||
|r2= [[Number]] - remaining tickets in all name spaces |RETURNVALUE2= | |r2= [[Number]] - remaining tickets in all name spaces |RETURNVALUE2= | ||
|x1= Add 5 tickets for BLUFOR | |x1= Add 5 tickets for BLUFOR | ||
| Line 45: | Line 40: | ||
|x3= Return number of player's tickets | |x3= Return number of player's tickets | ||
<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]] |SEEALSO= | ||
Revision as of 23:49, 16 January 2021
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
- Namespace - use missionNamespace to set/get global tickets available for everyone
- Side
- Group
- Object
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
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