Escort Goal

Goal Instructions

0.8 Escort Goal

Fastrack

/bot goal_create escort <name>
- this can be set anywhere in the map
/bot goal_setproperty vehicle <vehicle goal name>
- example: /bot goal_setproperty vehicle MOVER_truck
stand at an offset from the goal where the bot should escort from
/bot goal_setproperty offset 0
- optionally define additional offsets
- a blue line with an index label will be rendered for all offsets

Detailed Instructions

Description

Escort is a goal for the bots to escort vehicles. Typically trucks or boats.

Setup

See the Fastrack example at the top of the page for an example setup.

Properties

Properties can be set with the goal_setproperty command assuming that the goal has been selected.

group

A group is a method of organizing sets of goals. One advantage to this is that all goals in a group can be enabled or disabled in one line of script rather than seperate goal types requiring additional lines to enable or disable them. Assigning roles to a group is also possible as an alternative to assigning each individual goal a role.

syntax: /bot goal_setproperty group <string groupName>

example: /bot goal_setproperty group myGroup

role

See the section on bot roles.

syntax: /bot goal_setproperty role <role mask>

example: /bot goal_setproperty role 1

vehicle

This property attaches the goal to the specified vehicle.

syntax: /bot goal_setproperty vehicle <vehicle goal name>

example: /bot goal_setproperty vehicle MOVER_truck

offset

Sets a position where a bot should escort the vehicle from

syntax: /bot goal_setproperty offset <int index>

example: /bot goal_setproperty offset 0

button

Optionally set buttons for them to press while escorting. JUMP for boats is useful to keep them treading water.

syntax: /bot goal_setproperty button <optional clear>

example: /bot goal_setproperty button JUMP

example: /bot goal_setproperty button clear // clears all buttons

note: /bot goal_setproperty button -1 will list all valid button names

note: any number of buttons can be set. upon recieving the goal, the bot will randomly choose one to use in the case of multiples

tagname

Sets the name of the goal. This can optionally be set when passed as the optional parameter in the goal_create command. Useful for renaming goals.

syntax: /bot goal_setproperty tagname <string name>

example: /bot goal_setproperty tagname myGoalName

Picture of Escort Setup

Video Tutorial Version

Adding a Escort Goal