Difference between revisions of "Orbit (Procedure)"
Jump to navigation
Jump to search
imported>Henning m (moved Procedure Orbit to Orbit (Procedure)) |
imported>Jwoodward (copy from latest internal version) |
||
| Line 1: | Line 1: | ||
{{Procedures | {{Procedures | ||
|Name=Orbit | |Name=Orbit | ||
|Description= | |Description=Causes a flying actor to fly in circles around (and potentially above) the location. | ||
|Completes= | |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. | ||
|Param1=TargetLocation | |Param1=TargetLocation | ||
|Type1=Location | |Type1=Location | ||
|Desc1=Location to | |Desc1=Location around which to orbit. | ||
|Param2=InnerRadius | |Param2=InnerRadius | ||
|Type2=Float | |Type2=Float | ||
|Desc2= | |Desc2=Each circular path will get no closer (in horizontal distance) than this to the TargetLocation. | ||
|Param3=OuterRadius | |Param3=OuterRadius | ||
|Type3=Float | |Type3=Float | ||
|Desc3= | |Desc3=Each circular path will get no farther (in horizontal distance) than this from the TargetLocation. | ||
|Param4=Height | |Param4=Height | ||
|Type4=Float | |Type4=Float | ||
|Desc4= | |Desc4=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= | |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 (Procedure) | Hover]] | |||
}} | }} | ||
Revision as of 14:51, 8 February 2012
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}}}