Perch
The perch module allows agents to land on an height field and take off.
Attributes | Type | Overridable | Description |
---|---|---|---|
active | bool | yes | The active state of the agents. |
positionMetadataName | string | no | The metadata used as perching location |
upVectorMode | int | no | Defines the source of the landing up vector:
|
upVector | vector3 | no | The up vector used when the upVectorMode is set to 1 (User Value) |
upMetadataName | string | no | The metadata used representing the up vector at the perching location. If this value is specified and this metadata exists on the agent, it will override the other up vector settings. |
landingDistance | double | yes | The landing only starts when the distance from the target point and the agent is less than this distance |
perchState | int | yes | The state that will be used after landing |
sightAngle | double | no | If the target point is outside this view angle the landing does not take place |
takeOff | bool | yes | If on, the agent will take off after a timer has elapsed or the driving metadata is set to true. |
useTakeOffClipOnly | bool | yes | If on, the position of the agent won't be interpolated at take off, but only the clip animation will be used. |
takeOffTimer | vector2 | no | A random timer at the end of which the agent will take off. |
takeOffDistance | vector2 | no | At take off time a random distance within this range is picked and used to interpolate the agent position |
takeOffMaxAngle | double | no | The max angle allowed when calculating a take off vector from the ground contact point and its normal |
takeOffState | int | yes | The state that will be used after taking off |
takeOffMetadata | string | no | If a bool metadata name is specified then the agent is going to take off when its value is true |
avoidLandingTimer | vector2 | no | A random timer that will make sure an agent will not perch again until the timer is elapsed after take off |
seed | int | no | Random seed |
Copyright © 2017, Toolchefs LTD.