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))
(Added details)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Register curator object costs from a table.<br/>
 
You can export a table into spreadsheet using [[BIS_fnc_exportCuratorCostTable]] and use the result as param for this function.
Description:
|= Description
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):
0: OBJECT - curator
1: ARRAY of ARRAYs in format [<cost:Number>,<show:Bool>]


Returns:
| [curatorLogic, [className, cost, className, cost...]] call [[BIS_fnc_curatorObjectRegisteredTable]]; |= Syntax
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= curatorLogic: [[Object]] - The curator logic to set the object costs for. |= Parameter 1
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_curatorObjectRegisteredTable]]; --> |= Syntax
|p2= className: [[String]] - The class name of the object you wish to assign a cost to (must be followed by the associated cost). Any objects not listed in the array won't appear in the curator's unit list. |= Parameter 2


|p1= |= Parameter 1
|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. |= Parameter 3


| |= Return value
| [[Boolean]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_exportCuratorCostTable]] |= See also


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



Revision as of 18:53, 10 November 2014


Hover & click on the images for description

Description

Description:
Register curator object costs from a table.
You can export a table into spreadsheet using BIS_fnc_exportCuratorCostTable and use the result as param for this function.
Execution:
call
Multiplayer:
Must be executed where the logic is local (that is the machine of the player it is assigned to)
Groups:
Uncategorised

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 (must be followed by the associated cost). 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

Notes

Bottom Section