BIS fnc scriptedWaypointType: Difference between revisions

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


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Waypoints
____________________________________________________________________________________________


| Return CfgWaypoints type of scripted waypoint.
|descr= Return CfgWaypoints type of scripted waypoint.
Returns empty string/config when waypoint is not scripted
Returns empty string/config when waypoint is not scripted
Returns "Custom"/CfgWaypoints root when waypoint is using custom script.|Description=
Returns "Custom"/CfgWaypoints root when waypoint is using custom script.
____________________________________________________________________________________________


| [waypoint,type] call [[BIS_fnc_scriptedWaypointType]] |Syntax=
|s1= [waypoint,type] call [[BIS_fnc_scriptedWaypointType]]


|p1=waypoint: [[Array]] - Waypoint in question |Parameter 1=
|p1=waypoint: [[Array]] - waypoint in question


|p2=type: [[String]] or [[Config]] - (Optional, default [[configFile]]) Type of returned value, can by any string and any config|Parameter 2=
|p2=type: [[String]] or [[Config]] - (Optional, default [[configFile]]) type of returned value, can by any string and any config


| [[String]] or [[Config]] - String in format ("category/class") or config in format (CfgWaypoints path) |Return value=
|r1= [[String]] or [[Config]] - string in format ("category/class") or config in format (CfgWaypoints path)
____________________________________________________________________________________________


|x1= <code>[BIS_scripted_WP_01,"returnString"] [[call]] [[BIS_fnc_scriptedWaypointType]];</code>|Example 1=
|x1= <sqf>[BIS_scripted_WP_01,"returnString"] call BIS_fnc_scriptedWaypointType;</sqf>


____________________________________________________________________________________________
|seealso= [[Waypoints]] [[Custom Waypoints]]
 
| [[Waypoints]], [[Custom Waypoints]] |See also=
}}
}}
<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: Waypoints|{{uc:scriptedWaypointType}}]]
[[Category:Functions|{{uc:scriptedWaypointType}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:scriptedWaypointType}}]]

Latest revision as of 17:35, 8 November 2023

Hover & click on the images for description

Description

Description:
Return CfgWaypoints type of scripted waypoint. Returns empty string/config when waypoint is not scripted Returns "Custom"/CfgWaypoints root when waypoint is using custom script.
Execution:
call
Groups:
Waypoints

Syntax

Syntax:
[waypoint,type] call BIS_fnc_scriptedWaypointType
Parameters:
waypoint: Array - waypoint in question
type: String or Config - (Optional, default configFile) type of returned value, can by any string and any config
Return Value:
String or Config - string in format ("category/class") or config in format (CfgWaypoints path)

Examples

Example 1:
[BIS_scripted_WP_01,"returnString"] call BIS_fnc_scriptedWaypointType;

Additional Information

See also:
Waypoints Custom Waypoints

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