BIS fnc respawnTickets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[[^ ]+\] (call|spawn) ('''|\[\[)BI(N|S)_fnc_[a-zA-Z0-9_]+('''|\]\]));? \| *p1 *=" to " |s1=$1 |p1=")
m (Text replacement - " \| *([^= ]+) * +\|s2=" to " |r1=$1 |s2=")
Line 25: Line 25:
|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
|r1= [[Number]] - remaining tickets after adjustment


|s2= [] [[call]] [[BIS_fnc_respawnTickets]];
|s2= [] [[call]] [[BIS_fnc_respawnTickets]];

Revision as of 00:19, 13 June 2021

Hover & click on the images for description

Description

Description:
Description needed
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
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: 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