IGravitasSubject

Properties

GameObject GameObject

• Read-Only

• The GameObject this subject implementation is associated with.

IGravitasBody GravitasBody

• Read-Only

• The body this subject implementation is associated with.

IGravitasField CurrentField

• Read-Only

• The field this subject is currently within.

Vector3 AbsoluteAngularVelocity

• Read-Only

• The absolute world space angular velocity of this subject's body.

Vector3 AbsoluteVelocity

• Read-Only

• The absolute world space velocity of this subject's body.

float OrientSpeed

• Read-Only

• The speed at which this subject should orient itself.

bool AutoOrient

• Read-Only

• Whether or not this subject will orient itself to gravitational force acting on it.

bool CanChangeField

• Read-Only

• Whether or not this subject can change fields at the moment.

bool WillReorient

• Read-Only

• Whether or not this subject will attempt to right itself when it lands.

Events

Action<IGravitasField> OnEnterField

• Called when this subject enters a new field using the field as the argument.

Action<IGravitasField> OnExitField

• Called when this subject exits a field using the field as the argument.

Methods

void EnqueueFieldChangeRequest(GravitasFieldChangeRequest fieldChangeRequest)

• Adds a request to change field to be processed by this subject.

• fieldChangeRequest The request to enqueue.

void EnterField(IGravitasField field)

• Called when this subject enters the given field.

• field The field this subject is entering.

void ExitField(IGravitasField field)

• Called when this subject exits the given field.

• field The field this subject is exiting.

void SetReorientTimer(float time)

• Sets the value of this subject's re-orienting timer.

• time The time value to set.