Class RadialGravityFieldGroup

A composable collection of RadialGravityField instances. Calling apply() runs every member field once — convenient for multi-source scenarios (binary stars, three-body, planet platformers).

Index

Constructors

Properties

Accessors

Methods

add apply clear remove

Constructors

constructor

new RadialGravityFieldGroup(): RadialGravityFieldGroup
Returns RadialGravityFieldGroup

Properties

`Readonly`fields

fields: RadialGravityField[] = []

Ordered list of fields. Mutate via add / remove.

Accessors

length

get length(): number
Number of fields currently in the group.

Returns number
- Defined in packages/nape-js/src/helpers/RadialGravityField.ts:281

Methods

add

add(field: RadialGravityField): RadialGravityField
Add a field to the group and return it.
Parameters
- field: RadialGravityField
Returns RadialGravityField
- Defined in packages/nape-js/src/helpers/RadialGravityField.ts:262

apply

apply(space: Space): void
Apply every field's force contribution to all eligible bodies in space. Forces stack additively, preserving any userland body.force writes.
Parameters
- space: Space
Returns void
- Defined in packages/nape-js/src/helpers/RadialGravityField.ts:289

clear

clear(): void
Remove all fields.

Returns void
- Defined in packages/nape-js/src/helpers/RadialGravityField.ts:276

remove

remove(field: RadialGravityField): boolean
Remove a field from the group. Returns true if it was present.
Parameters
- field: RadialGravityField
Returns boolean
- Defined in packages/nape-js/src/helpers/RadialGravityField.ts:268