BIS fnc scriptedWaypointType: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \[\[Category:\{\{Name\|arma3\}\}:[_ ]Functions\|[^ ]+\]\]" to "")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *W([a-z ])" to "$1 - w$2")
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Waypoints
|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.
Returns "Custom"/CfgWaypoints root when waypoint is using custom script.


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


|p1=waypoint: [[Array]] - Waypoint in question
|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
|p2=type: [[String]] or [[Config]] - (Optional, default [[configFile]]) type of returned value, can by any string and any config


|r1=[[String]] or [[Config]] - String in format ("category/class") or config in format (CfgWaypoints path)
|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>
|x1= <sqf>[BIS_scripted_WP_01,"returnString"] call BIS_fnc_scriptedWaypointType;</sqf>


|seealso= [[Waypoints]], [[Custom Waypoints]]
|seealso= [[Waypoints]] [[Custom Waypoints]]
}}
}}

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