BIS fnc scriptedWaypointType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Waypoints(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Waypoints |GROUP1=
|gr1 = Waypoints |GROUP1=
____________________________________________________________________________________________


| Return CfgWaypoints type of scripted waypoint.
| 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.|Description=
____________________________________________________________________________________________


| [waypoint,type] call [[BIS_fnc_scriptedWaypointType]] |Syntax=
| [waypoint,type] call [[BIS_fnc_scriptedWaypointType]] |Syntax=
Line 21: Line 18:


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


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


____________________________________________________________________________________________


| [[Waypoints]], [[Custom Waypoints]]  |See also=
| [[Waypoints]], [[Custom Waypoints]]  |See also=

Revision as of 00:45, 17 January 2021

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:
WaypointsCustom 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

Notes

Bottom Section