IGravitasField

Properties

Collider BoundaryCollider

• Read-Only

• The trigger collider defining where this field starts and ends.

FixedDirection FixedDirection

• Gets or sets the fixed direction of this field, controlling the force of gravitational acceleration.

GameObject GameObject

• Read-Only

• The GameObject this field implementation is associated with.

Vector3 FieldAbsoluteAngularVelocity

• Read-Only

• The absolute world space angular velocity of this field.

Vector3 FieldAbsoluteVelocity

• Read-Only

• The absolute world space velocity of this field.

Vector3 FieldAngularVelocity

• Read-Only

• The angular velocity of the field relative to its frame of reference.

Vector3 FieldVelocity

• Read-Only

• The velocity of the field relative to its frame of reference.

Vector3 LocalFieldCenter

• Read-Only

• The center of this gravity field.

float Acceleration

• Read-Only

• The magnitude of acceleration this field exerts on subjects.

float PhysicsSceneBoundaryScaleFactor

• The factor to scale the exit boundary collider by when this field produces a local physics scene.

int Priority

• The priority this field should be considered with.

Events

Action<IGravitasSubject> OnSubjectAdded

• Called when a subject is added to this field using the new subject as the argument.

Action<IGravitasSubject> OnSubjectRemoved

• Called when a subject is removed from this field using the subject as the argument.

Methods

void AddSubjectToField(IGravitasSubject subject)

• Proxies the given subject in this field.

• subject The subject to add.

void DestroySubjectFromField(IGravitasSubject subject)

• Destroys the given subject's proxy from this field.

• subject The subject to destroy.

void EnqueueSubjectChange(IGravitasSubject subject, bool add)

• Enqueues a change to the field's subject to be processed at the next field update.

• subject The subject to add or remove.

• add Whether to add or remove the subject.

void FlushSubjectChanges()

• Processes and performs all subject changes for this field.

void StartScan()

• Performs the startup scan for this field.

void UnloadPhysicsScene()

• Unloads this field's physics scene from memory.

void UpdatePhysicsSceneProxies()

• Apply gravitational forces to the subjects in this field.

void UpdatePhysicsSceneSimulation(float timeStep)

• Updates the simulation of this field's physics scene by the given time step.

• timeStep The amount of time to simulate.

void UpdateSubjectPositions()

• Sync positions between all subjects and their proxies.

Collider[] GetFieldColliders()

• Gets a collection of colliders used by this field.

float GetDistanceMultiplier(Vector3 localPos)

• Gets the distance multiplier based on a given local position.

• localPos The position relative to the field center.

float GetDistanceMultiplier(float normalizedDistance)

• Gets the distance multiplier based on the given normalized distance from the center.

• normalizedDistance The normalized distance representing distance from the field center.

bool ContainsSubject(IGravitasSubject subject)

• Returns whether or not this field is simulating the given subject.

• subject The subject to check.