Waypoint Library - Revision history

Palota: /* AddWaypoint */

2025-07-05T10:57:25Z

AddWaypoint

← Older revision		Revision as of 10:57, 5 July 2025
Line 15:		Line 15:
	<nowiki><Vector3></nowiki> The position to add waypoint.		<nowiki><Vector3></nowiki> The position to add waypoint.

	<nowiki><Vector3></nowiki> The facing for the waypoint.		<nowiki><optional Vector3></nowiki> The facing for the waypoint.

	'''Returns'''		'''Returns'''
Line 23:		Line 23:
	'''Example'''		'''Example'''
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	Wp.AddWaypoint(Vector3(1000,2000,1000~~),Vector3(0,0,0~~))</syntaxhighlight>		Wp.AddWaypoint(Vector3(1000,2000,1000))</syntaxhighlight>

	== CheckBlockable ==		== CheckBlockable ==

Palota: SetWaypointFlag parameters

2023-06-12T08:21:01Z

SetWaypointFlag parameters

← Older revision		Revision as of 08:21, 12 June 2023
Line 217:		Line 217:
	<nowiki><int></nowiki> Guid of a waypoint '''OR'''<nowiki> <string></nowiki> Name of the waypoint or a regular expression.		<nowiki><int></nowiki> Guid of a waypoint '''OR'''<nowiki> <string></nowiki> Name of the waypoint or a regular expression.

	<nowiki><string></nowiki> The name of the flag to set.		<nowiki><string></nowiki> The name of the flag to set '''OR''' <nowiki><table></nowiki> Multiple flags to set.

	<nowiki><int></nowiki> True to set, false to clear.		<nowiki><int></nowiki> True to set, false to clear.
Line 227:		Line 227:
	'''Example'''		'''Example'''
	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	Wp.SetWaypointFlag("waypointname", "closed", ~~true~~)		Wp.SetWaypointFlag("waypointname", "closed", false);
	Wp.SetWaypointFlag("bridge_.*", "crouch", true);</syntaxhighlight>		Wp.SetWaypointFlag("bridge_.*", "crouch", true);
			Wp.SetWaypointFlag("main_entrance", { "axis", "door" }, true );</syntaxhighlight>

	== SetWaypointName ==		== SetWaypointName ==

Palota: CheckBlockable, Disconnect

2023-06-12T08:08:45Z

CheckBlockable, Disconnect

@@ Line 24: / Line 24: @@
 <syntaxhighlight lang="java">
   Wp.AddWaypoint(Vector3(1000,2000,1000),Vector3(0,0,0))</syntaxhighlight>
 == Connect ==
@@ Line 52: / Line 63: @@
 <syntaxhighlight lang="java">
   Wp.DeleteWaypoint(Vector3(1000,2000,1000))</syntaxhighlight>
 == GetAllWaypoints ==

Palota: 1 revision imported

2023-02-13T07:02:37Z

1 revision imported

← Older revision	Revision as of 07:02, 13 February 2023
(No difference)

Palota: /* SetWaypointFlag */

2021-07-14T08:20:37Z

SetWaypointFlag

New page

{{process header
| title = Waypoint Library
| section =
| previous = [[Omni-bot_Script_Reference | Script Reference]]
| next =
| shortcut =
| notes =
}}
{{TOCright}}
== AddWaypoint ==
Creates a new waypoint at a specified location.

'''Parameters'''

<nowiki><Vector3></nowiki> The position to add waypoint.

<nowiki><Vector3></nowiki> The facing for the waypoint.

'''Returns'''

int Waypoint Id if successful OR null if there was an error adding waypoint.

'''Example'''
<syntaxhighlight lang="java">
Wp.AddWaypoint(Vector3(1000,2000,1000),Vector3(0,0,0))</syntaxhighlight>

== Connect ==
Connects two waypoints

'''Parameters'''

<nowiki><int></nowiki> Guid of a waypoint.

<nowiki><int></nowiki> Guid of another waypoint.

'''Returns'''

true if successful, false if not

== DeleteWaypoint ==
Delete a waypoint from a specified location.

'''Parameters'''

<nowiki><Vector3></nowiki> <nowiki>The <Vector3> position to delete waypoint from.</nowiki>

'''Returns'''

true if successful, false if not

'''Example'''
<syntaxhighlight lang="java">
Wp.DeleteWaypoint(Vector3(1000,2000,1000))</syntaxhighlight>

== GetAllWaypoints ==
Gets all waypoints.

'''Parameters'''

<nowiki><table></nowiki> An empty table, the function will fill tables of position, facing, guid, radius, name, flags, property.

'''Returns'''

None

'''Example'''
<syntaxhighlight lang="java">
wpTable = {};
Wp.GetAllWaypoints( wpTable );
foreach( waypoint in wpTable ) {
if( waypoint.name ) {
print(waypoint.name, "-", waypoint.position);
}
}

</syntaxhighlight>

== GetClosestWaypoint ==
Gets waypoint near position.

'''Parameters'''

<Vector3> position

<optional int> team

<optional options> 1=don't skip closed waypoints, 2=ignore waypoints without connections

'''Returns'''

<nowiki><table></nowiki>

'''Example'''
<syntaxhighlight lang="java">
w = Wp.GetClosestWaypoint( Vec3(100,200,0) );
if(w) {
print("waypoint UID ", w.guid);
}
</syntaxhighlight>

== GetAllSelectedWaypoints ==
Gets selected waypoints.

'''Parameters'''

<nowiki><table></nowiki> An empty table, the function will fill tables of position, facing, guid, radius, name, flags, property.

'''Returns'''

None

== GetWaypointByGUID ==
Gets a waypoint information by its guid.

'''Parameters'''

<nowiki><int></nowiki> Guid of a waypoint.

<nowiki><table></nowiki> An empty table, the function will fill in position, facing, guid, radius, name, flags, property.

'''Returns'''

true if successful, false if not

== GetWaypointByName ==
Gets a waypoint's information by its name.

'''Parameters'''

<nowiki><string></nowiki> The name of the waypoint to get the info of.

<nowiki><table></nowiki> An empty table, the function will fill in position, facing, guid, radius, name, flags, property.

'''Returns'''

true if successful, false if not

== IsWaypointViewOn ==
Checks if waypoint view is on.

'''Parameters'''

None

'''Returns'''

int true if waypoint_view is on, false if not

'''Example'''
<syntaxhighlight lang="java">
Wp.IsWaypointViewOn()</syntaxhighlight>

== Load ==
Loads waypoints from nav folder.

'''Parameters'''

<nowiki><optional string></nowiki> File name.

'''Returns'''

true if successful, false if not

== Save ==
Saves waypoints to nav folder.

'''Parameters'''

<nowiki><optional string></nowiki> File name.

'''Returns'''

true if successful, false if not

== SetRadius ==
Sets a wapoint radius.

'''Parameters'''

<nowiki><int></nowiki> Guid of a waypoint

<nowiki><int></nowiki> Radius.

'''Returns'''

true if successful, false if not

== SetWaypointFlag ==
Sets the [[Waypoint_Flags|flag]] on a waypoint by name.

'''Parameters'''

<nowiki><int></nowiki> Guid of a waypoint '''OR'''<nowiki> <string></nowiki> Name of the waypoint or a regular expression.

<nowiki><string></nowiki> The name of the flag to set.

<nowiki><int></nowiki> True to set, false to clear.

'''Returns'''

None

'''Example'''
<syntaxhighlight lang="java">
Wp.SetWaypointFlag("waypointname", "closed", true)
Wp.SetWaypointFlag("bridge_.*", "crouch", true);</syntaxhighlight>

== SetWaypointName ==
Assigns a name to a waypoint.

'''Parameters'''

<nowiki><int></nowiki> The id of the waypoint to set the name of.

<nowiki><string></nowiki> The name to assign to the waypoint.

'''Returns'''

true if successful, false if not

== SetWaypointProperty ==
Sets the waypoint property.

'''Parameters'''

<nowiki><int></nowiki> Guid of a waypoint '''OR'''<nowiki> <string></nowiki> Name of the waypoint.

<nowiki><string></nowiki> The name of the property to set.

<nowiki><string></nowiki> Property value to set.

'''Returns'''

None

== WaypointColor ==
Customize the color of various types of waypoints, paths, etc... See [[Waypoint_Commands#waypoint_color|waypoint_color]] command for help.

'''Parameters'''

<nowiki><string></nowiki> The name of the category to set a color for.

<nowiki><int></nowiki> The color to use for this type.

'''Returns'''

None

=Properties=

== BlockablePathOffset ==
the offset for blockable paths for drawing purposes.

== BottomPathOffset ==
the offset for path bottom for drawing purposes.

== BottomWaypointOffset ==
the offset for waypoint bottom for drawing purposes.

== FacingOffset ==
the offset for drawing the facing indicator.

== PathLevelOffset ==
relative offset for path finding, default is 0.5

== TextDuration ==
drawing duration for texts, default is 2 seconds

== TextOffset ==
the offset for drawing waypoint name, UID, radius, flags.

== TopPathOffset ==
the offset for path top for drawing purposes.

== TopWaypointOffset ==
the offset for waypoint top for drawing purposes.