BIS fnc curatorObjectRegisteredTable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (GVI 1.00 --> 1.16 http://dev.arma3.com/post/spotrep-00023 (It's Zeus update, obvious))
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(44 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


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


| arma3 |= Game name
|gr1= Curator


|1.16|= Game version
|descr= Register curator object costs from a table.<br>
____________________________________________________________________________________________
A table can be exported into a spreadsheet using [[BIS_fnc_exportCuratorCostTable]] and used as argument for this function.


| <pre>/*
|s1= [curatorLogic, [className, cost, className, cost...]] call [[BIS_fnc_curatorObjectRegisteredTable]]


Description:
|p1= curatorLogic: [[Object]] - the curator logic to set the object costs for.
Register objects costs from table.
Export a table into spreadsheet using BIS_fnc_exportCuratorCostTable and use the result as param for this function.


Parameter(s):
|p2= className: [[String]] - the class name of the object you wish to assign a cost to. Any objects not listed in the array won't appear in the curator's unit list.
0: OBJECT - curator
1: ARRAY of ARRAYs in format [<cost:Number>,<show:Bool>]


Returns:
|p3= cost: [[Number]] - the cost you wish to assign to the preceding object. The cost should be between 0 and 1, with 1 representing the entire resource bar of the curator.
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|r1= [[Boolean]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_curatorObjectRegisteredTable]]; --> |= Syntax
|x1= <sqf>// Nothing but the listed flare modules will show up in the curator's unit list
[getAssignedCuratorLogic player, ["ModuleFlareWhite_F",0.02,"ModuleFlareYellow_F",0.02,"ModuleFlareGreen_F",0.02]] call BIS_fnc_curatorObjectRegisteredTable;</sqf>


|p1= |= Parameter 1
|seealso= [[BIS_fnc_exportCuratorCostTable]]
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|mp= Must be executed where the logic is local (on the machine of the player it is assigned to)
}}
}}


<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
<dt></dt>
<dd class="notedate">Posted on 2014-11-10 - 17:02 (UTC)</dd>
<dt class="note">[[User:SilentSpike|SilentSpike]]</dt>
<dd class="note">
Be aware that you must provide an equal number of elements to the array of class names and costs.
That mean every class name should be followed by an associated cost.
You can add as many objects as you want as long as this condition is met.
</dd>
 
</dl>
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Curator|{{uc:curatorObjectRegisteredTable}}]]
[[Category:Functions|{{uc:curatorObjectRegisteredTable}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:curatorObjectRegisteredTable}}]]

Latest revision as of 16:50, 8 November 2023

Arma 3 logo black.png1.16
Hover & click on the images for description

Description

Description:
Register curator object costs from a table.
A table can be exported into a spreadsheet using BIS_fnc_exportCuratorCostTable and used as argument for this function.
Execution:
call
Multiplayer:
Must be executed where the logic is local (on the machine of the player it is assigned to)
Groups:
Curator

Syntax

Syntax:
[curatorLogic, [className, cost, className, cost...]] call BIS_fnc_curatorObjectRegisteredTable
Parameters:
curatorLogic: Object - the curator logic to set the object costs for.
className: String - the class name of the object you wish to assign a cost to. Any objects not listed in the array won't appear in the curator's unit list.
cost: Number - the cost you wish to assign to the preceding object. The cost should be between 0 and 1, with 1 representing the entire resource bar of the curator.
Return Value:
Boolean

Examples

Example 1:
// Nothing but the listed flare modules will show up in the curator's unit list [getAssignedCuratorLogic player, ["ModuleFlareWhite_F",0.02,"ModuleFlareYellow_F",0.02,"ModuleFlareGreen_F",0.02]] call BIS_fnc_curatorObjectRegisteredTable;

Additional Information

See also:
BIS_fnc_exportCuratorCostTable

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
Posted on 2014-11-10 - 17:02 (UTC)
SilentSpike
Be aware that you must provide an equal number of elements to the array of class names and costs. That mean every class name should be followed by an associated cost. You can add as many objects as you want as long as this condition is met.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_curatorObjectRegisteredTable&oldid=349171"