Struct Location
A custom trait for locations, since it is commonly used in domains
Namespace: Unity.AI.Planner.Traits
Syntax
[Serializable]
public struct Location : ICustomTrait, ITrait, IBufferElementData, IEquatable<Location>Fields
Forward
The forward vector of the location
Declaration
public Vector3 ForwardField Value
| Type | Description |
|---|---|
| Vector3 |
Position
The position of the location
Declaration
public Vector3 PositionField Value
| Type | Description |
|---|---|
| Vector3 |
TransformInstanceId
The Id of the transform of the location
Declaration
[FormerlySerializedAs("TransformInstanceID")]
public int TransformInstanceIdField Value
| Type | Description |
|---|---|
| Int32 |
Properties
Transform
The transform of the location
Declaration
public Transform Transform { get; set; }Property Value
| Type | Description |
|---|---|
| Transform |
Methods
Equals(Location)
Compares this location to another
Declaration
public bool Equals(Location other)Parameters
| Type | Name | Description |
|---|---|---|
| Location | other | Another location to which the location is compared |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the two locations are equal |
GetField(String)
Get the value of a field
Declaration
public object GetField(string fieldName)Parameters
| Type | Name | Description |
|---|---|---|
| String | fieldName | Name of field |
Returns
| Type | Description |
|---|---|
| Object | Field value if field exists |
Implements
SetField(String, Object)
Set the value of a field
Declaration
public void SetField(string fieldName, object value)Parameters
| Type | Name | Description |
|---|---|---|
| String | fieldName | Name of field |
| Object | value | Value |
Implements
ToString()
Returns a string that represents the location
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | A string that represents the location |