BIS fnc initDisplay: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(5th parameter)
Line 21: Line 21:
|p1= parameters: [[Array]]
|p1= parameters: [[Array]]
* [ ] (empty array) - init displays during preStart
* [ ] (empty array) - init displays during preStart
* [mode, params, displayClass, scriptPath]
* [mode, params, displayClass, scriptPath, register]
** mode: [[String]] -  mode, can be "onLoad" or "onUnload"
** mode: [[String]] -  mode, can be "onLoad" or "onUnload"
** params: [[Array]] - params passed from [[User_Interface_Event_Handlers#onLoad|onLoad]] or [[User_Interface_Event_Handlers#onUnload|onUnload]] UI event handler
** params: [[Array]] - params passed from [[User_Interface_Event_Handlers#onLoad|onLoad]] or [[User_Interface_Event_Handlers#onUnload|onUnload]] UI event handler
** displayClass: [[String]] - [[Display]] class, usually to format "RscDisplayXXX"
** displayClass: [[String]] - [[Display]] class, usually to format "RscDisplayXXX"
** scriptPath: [[String]] - script path from CfgScriptPaths
** scriptPath: [[String]] - script path from CfgScriptPaths
** register: [[Number]] or [[Bool]] - Save variables associated with the display to the uiNamespace. Usually this is <tt>false</tt> when the function is called from a control.
&nbsp; |PARAMETER1=
&nbsp; |PARAMETER1=


Line 31: Line 32:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>["onLoad", [[_this]], "RscDisplayAAR", "GUI"] [[call]] ([[uiNamespace]] [[getVariable]] "[[BIS_fnc_initDisplay]]");</code> |EXAMPLE1=
|x1= <code>["onLoad", [[_this]], "RscDisplayAAR", "GUI", true] [[call]] ([[uiNamespace]] [[getVariable]] "[[BIS_fnc_initDisplay]]");</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 17:01, 19 October 2020

Hover & click on the images for description

Description

Description:
Initialize displays during preStart or init GUI display and run its script.
The config class of the display is available in "BIS_fnc_initDisplay_configClass" stored on display: _display getVariable "BIS_fnc_initDisplay_configClass"; Display is also stored in uiNamespace variable with config class name: uiNamespace getVariable "RscAvCamera";
Execution:
call
Groups:
GUI

Syntax

Syntax:
parameters call BIS_fnc_initDisplay
Parameters:
parameters: Array
  • [ ] (empty array) - init displays during preStart
  • [mode, params, displayClass, scriptPath, register]
    • mode: String - mode, can be "onLoad" or "onUnload"
    • params: Array - params passed from onLoad or onUnload UI event handler
    • displayClass: String - Display class, usually to format "RscDisplayXXX"
    • scriptPath: String - script path from CfgScriptPaths
    • register: Number or Bool - Save variables associated with the display to the uiNamespace. Usually this is false when the function is called from a control.
 
Return Value:
Nothing

Examples

Example 1:
["onLoad", _this, "RscDisplayAAR", "GUI", true] call (uiNamespace getVariable "BIS_fnc_initDisplay");

Additional Information

See also:
See also needed

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