BIS fnc bleedTickets: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= |p4=" to "|PARAMETER3= |p4=")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )D([a-z])" to "$1d$3")
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|Comments=
|game1= arma3
____________________________________________________________________________________________
|version1= 1.10


| arma3 |Game name=
|gr1= Missions


|1.10|Game version=
|descr= Function that handles bleeding ticket system. Tickets are set beforehand using [[BIS_fnc_respawnTickets]].
____________________________________________________________________________________________


| Function that handles bleeding ticket system. Tickets are set beforehand using [[BIS_fnc_respawnTickets]]. |DESCRIPTION=
|mp= Server-side execution only.
____________________________________________________________________________________________


| [<nowiki>[WEST,EAST,RESISTANCE,CIVILIAN]</nowiki>, 0.5, 3, 5] call '''BIS_fnc_bleedTickets'''; |SYNTAX=
|s1= [sides, dominanceRatio, bleedingAmount, bleedingDelay] call [[BIS_fnc_bleedTickets]]


|p1= [[Array]] - Array of sides that should be affected by bleed tickets. ''Optional parameter, default is '''all''' sides''.|Parameter1=
|p1= sides: [[Array]] - (Optional, default All sides) array of effected sides
|p2= [[Number]] - Dominance ratio, values from 0 to 1. Determines how much of a sector a side must hold for bleeding tickets to start. ''Optional parameter, default is 0.5 (ie half a sector)''. |Parameter2=


|p3= [[Number]] - Amount of tickets bled every step. ''Optional parameter, default value 3''. |PARAMETER3=
|p2= dominanceRatio: [[Number]] - (Optional, default 0.5) dominance ratio, values from 0 to 1. Determines how much of a sector a side must hold for bleeding tickets to start


|p4= [[Number]] - Delay in seconds between every bleeding step. ''Optional parameter, default value 5''. |=
|p3= bleedingAmount: [[Number]] - (Optional, default 3) amount of tickets bled every step. Optional parameter


| [[Boolean]] |RETURNVALUE=
|p4= bleedingDelay: [[Object]] - (Optional, default 5) delay in seconds between every bleeding step
|mp= Server-side execution only. |=
____________________________________________________________________________________________


|x1= <code>[] call BIS_fnc_bleedTickets; // Uses all default values to start the system.</code> |Example1=
|r1= [[Boolean]]
|x2= <code><nowiki>[[WEST,EAST], 1, 1, 10]</nowiki> call BIS_fnc_bleedTickets; // Starts the system with WEST and EAST involved, bleeding one ticket every ten seconds if one side holds the whole sector.</code> |=
____________________________________________________________________________________________


| [[BIS_fnc_addScriptedEventHandler]] |SEEALSO=
|x1= <sqf>call BIS_fnc_bleedTickets;</sqf>


|x2= <sqf>[[west, east], 1, 1, 10] call BIS_fnc_bleedTickets;</sqf>
|seealso= [[BIS_fnc_addScriptedEventHandler]] [[BIS_fnc_respawnTickets]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Tryteyker-
<!-- Note Section BEGIN -->
|timestamp= 20140929195800
 
|text= The function calls on the scripted eventhandler (see [[BIS_fnc_addScriptedEventHandler]]) "dominantSideChanged" everytime a sector changes dominant side (this again depending on the value given to the function).
<!-- Note Section END -->
}}
</dl>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Systems|{{uc:bleedTickets}}]]
[[Category:Functions|{{uc:bleedTickets}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:bleedTickets}}]]
 
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 29, 2014 - 19:58 (UTC)</dd>
<dt class="note">[[User:Tryteyker-|Tryteyker-]]</dt>
<dd class="note">
The function calls on the scripted eventhandler (see [[BIS_fnc_addScriptedEventHandler]]) "dominantSideChanged" everytime a sector changes dominant side (this again depending on the value given to the function).
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 12:28, 8 November 2023

Hover & click on the images for description

Description

Description:
Function that handles bleeding ticket system. Tickets are set beforehand using BIS_fnc_respawnTickets.
Execution:
call
Multiplayer:
Server-side execution only.
Groups:
Missions

Syntax

Syntax:
[sides, dominanceRatio, bleedingAmount, bleedingDelay] call BIS_fnc_bleedTickets
Parameters:
sides: Array - (Optional, default All sides) array of effected sides
dominanceRatio: Number - (Optional, default 0.5) dominance ratio, values from 0 to 1. Determines how much of a sector a side must hold for bleeding tickets to start
bleedingAmount: Number - (Optional, default 3) amount of tickets bled every step. Optional parameter
bleedingDelay: Object - (Optional, default 5) delay in seconds between every bleeding step
Return Value:
Boolean

Examples

Example 1:
call BIS_fnc_bleedTickets;
Example 2:
[[west, east], 1, 1, 10] call BIS_fnc_bleedTickets;

Additional Information

See also:
BIS_fnc_addScriptedEventHandler BIS_fnc_respawnTickets

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
Tryteyker- - c
Posted on Sep 29, 2014 - 19:58 (UTC)
The function calls on the scripted eventhandler (see BIS_fnc_addScriptedEventHandler) "dominantSideChanged" everytime a sector changes dominant side (this again depending on the value given to the function).