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
(see also) |
m (template:command argument fix) |
||
| 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. | ||
|= | |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]]; |= | | [<target>,(<tickets>,<dynamicTarget>)] call [[BIS_fnc_respawnTickets]]; |SYNTAX= | ||
|p1= '''target''': Receiver of the respawn loadout | |p1= '''target''': Receiver of the respawn loadout | ||
| Line 27: | Line 27: | ||
|p3= '''dynamicTarget''': [[Boolean]] - when [[true]], set/get tickets based on the target. '''target''' must be an [[Object]]. | |p3= '''dynamicTarget''': [[Boolean]] - when [[true]], set/get tickets based on the target. '''target''' must be an [[Object]]. | ||
| [[Number]] - remaining tickets after adjustment |= | | [[Number]] - remaining tickets after adjustment |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s2= [] [[call]] [[BIS_fnc_respawnTickets]]; |= | |s2= [] [[call]] [[BIS_fnc_respawnTickets]]; |SYNTAX= 2 | ||
|r2= [[Number]] - remaining tickets in all name spaces |= | |r2= [[Number]] - remaining tickets in all name spaces |RETURNVALUE= 2 | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 45: | Line 45: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[Arma 3 Respawn]], [[BIS_fnc_addRespawnPosition]], [[BIS_fnc_removeRespawnPosition]] |= | | [[Arma 3 Respawn]], [[BIS_fnc_addRespawnPosition]], [[BIS_fnc_removeRespawnPosition]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:32, 7 April 2019
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
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