BIS fnc respawnTickets: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*)<\/code>" to "<code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "[[Arma 3 " to "[[Arma 3: ") |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
|eff= global | |eff= global | ||
|descr= Manage respawn tickets used by [[Arma 3 Respawn#Respawn Templates|Tickets]] respawn template.<br> | |descr= Manage respawn tickets used by [[Arma 3: Respawn#Respawn Templates|Tickets]] respawn template.<br> | ||
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 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. | ||
| Line 31: | Line 31: | ||
|x1= Add 5 tickets for BLUFOR: | |x1= Add 5 tickets for BLUFOR: | ||
< | <sqf>[west, 5] call BIS_fnc_respawnTickets;</sqf> | ||
|x2= Return number of global tickets: | |x2= Return number of global tickets: | ||
< | <sqf>_globalTickets = [missionNamespace] call BIS_fnc_respawnTickets;</sqf> | ||
|x3= Return number of player's tickets: | |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]] | |seealso= [[Arma 3: Respawn]] [[BIS_fnc_addRespawnPosition]] [[BIS_fnc_removeRespawnPosition]] | ||
}} | }} | ||
Latest revision as of 10:38, 6 May 2024
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:
- Example 2:
- Return number of global tickets:
- Example 3:
- Return number of player's tickets:
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