BIS fnc 3DENTutorial: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *P([a-gi-z ])" to "$1 - p$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.56


|1.56|= Game version
|gr1= Eden Editor
____________________________________________________________________________________________


|Show tutorial in [[Eden Editor]]
|descr=Show tutorial in [[:Category:Eden Editor|Eden Editor]].
{{warning|Currently (v1.82) not working because parameter one requires a display instead of string}}|= Description
____________________________________________________________________________________________


| [path, index, oneStep, display] call [[BIS_fnc_3DENTutorial]] |= Syntax
|s1= [path, index, oneStep, display] call [[BIS_fnc_3DENTutorial]]


|p1= path: [[String]] - Path in format [<categoryClass>,<tutorialClass>], classes are from [[Cfg3DEN]] >> Tutorials |=Parameter 1
|p1= path: [[Array]] - path in format [<categoryClass>,<tutorialClass>], classes are from '''Cfg3DEN >> Tutorials'''


|p2= index: [[Number]] - Index of step at which tutorial starts '''Default:''' 0 |=Parameter 2
|p2= index: [[Number]] - (Optional, default 0) index of step at which tutorial starts


|p3= oneStep: [[Boolean]] - True to show only one step, without ability to go forward or backward '''Optional''', '''Default:''' false|=Parameter 3
|p3= oneStep: [[Boolean]] - (Optional, default [[false]]) true to show only one step, without ability to go forward or backward


|p4= display: [[Display]] - Main display used. '''Optional''', '''Default:''' Display3DEN|=Parameter 4
|p4= display: [[Display]] - (Optional, default Eden display) display used


|[[Nothing]]|= Return value
|r1= [[Nothing]]
____________________________________________________________________________________________


|x1= <code>["Connecting", 0, false] [[call]] [[BIS_fnc_3DENTutorial]];</code> |= Parameter 1
|x1= <sqf>[["Editing", "Connecting"], 0, false] call BIS_fnc_3DENTutorial;</sqf>
____________________________________________________________________________________________


|[[Eden Editor]], [[Eden Editor: Configuring Tutorials]]|= See also
|seealso= [[:Category:Eden Editor|Eden Editor]] [[Eden Editor: Configuring Tutorials]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Default|{{uc:3DENTutorial}}]]
[[Category:Functions|{{uc:3DENTutorial}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:3DENTutorial}}]]

Latest revision as of 15:45, 8 November 2023

Hover & click on the images for description

Description

Description:
Show tutorial in Eden Editor.
Execution:
call
Groups:
Eden Editor

Syntax

Syntax:
[path, index, oneStep, display] call BIS_fnc_3DENTutorial
Parameters:
path: Array - path in format [<categoryClass>,<tutorialClass>], classes are from Cfg3DEN >> Tutorials
index: Number - (Optional, default 0) index of step at which tutorial starts
oneStep: Boolean - (Optional, default false) true to show only one step, without ability to go forward or backward
display: Display - (Optional, default Eden display) display used
Return Value:
Nothing

Examples

Example 1:
[["Editing", "Connecting"], 0, false] call BIS_fnc_3DENTutorial;

Additional Information

See also:
Eden Editor Eden Editor: Configuring Tutorials

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