Orbit (Procedure)

Behavior

Description:
Causes a flying actor to fly in circles around (and potentially above) the location.

The procedure completes:
After one complete revolution around the location. At that time, if no other procedures or packages take precedence, the actor will continue with another complete loop around the location.

Parameters

• TargetLocation (Location): Location around which to orbit.
• InnerRadius (Float): Each circular path will get no closer (in horizontal distance) than this to the TargetLocation.
• OuterRadius (Float): Each circular path will get no farther (in horizontal distance) than this from the TargetLocation.
• Height (Float): Each circular path around the TargetLocation will be at this height above it. Useful for orbiting above a target location that has to be on the ground (such as a non-flying actor or a quest alias to a marker).

                               

Notes

• Each time the actor completes one loop around the location, it will pick a new goal radius (between the specified inner and outer radii) and build a new circular path for the next loop.
• The height parameter exists to allow orbiting above a target location that has to be on the ground (for instance, because the location is based on a non-flying actor, or a quest alias). If the target location is based on a marker made specifically for this actor to orbit, then it is perfectly valid to use a height of 0 and simply place the marker itself in the air at the desired height.
• Related procedures: Hover

See Also

{{{SeeAlso}}}