Class DarkKnight

Describes all celestial bodies (a combination of OrbitalObject, CanHaveRings)

Implements

CelestialBodyBase<DARK_KNIGHT>

Index

Constructors

Properties

asteroidField model ringsUniforms targetInfo type

Methods

dispose getBoundingRadius getRadius getTransform getTypeName

Constructors

constructor

new DarkKnight(model: DeepReadonly<DarkKnightModel>, scene: Scene): DarkKnight
Parameters
- model: DeepReadonly<DarkKnightModel>
- scene: Scene
Returns DarkKnight
- Defined in src/ts/frontend/universe/darkKnight.ts:49

Properties

`Readonly`asteroidField

asteroidField: null | AsteroidField = null

Returns the asteroid belt of the object's ring, or null if the object has no rings

`Readonly`model

model: DeepReadonly<DarkKnightModel>

`Readonly`ringsUniforms

ringsUniforms: null | RingsUniforms = null

Returns the uniforms used to render the rings, or null if the object has no rings

`Readonly`targetInfo

targetInfo: TargetInfo

`Readonly`type

type: DARK_KNIGHT

Methods

dispose

dispose(): void
Returns void
- Defined in src/ts/frontend/universe/darkKnight.ts:85

getBoundingRadius

getBoundingRadius(): number
Returns the radius describing the max extent of the object from its center

Returns number
Implementation of CelestialBodyBase.getBoundingRadius
- Defined in src/ts/frontend/universe/darkKnight.ts:73

getRadius

getRadius(): number
Returns the radius of the celestial body

Returns number
Implementation of CelestialBodyBase.getRadius
- Defined in src/ts/frontend/universe/darkKnight.ts:69

getTransform

getTransform(): TransformNode
Returns the transform node of the Transformable object

Returns TransformNode
Implementation of CelestialBodyBase.getTransform
- Defined in src/ts/frontend/universe/darkKnight.ts:81

getTypeName

getTypeName(): string
Returns the type name of the object. This is used as a short identifier in the UI Overlay of the object

Returns string
Implementation of CelestialBodyBase.getTypeName
- Defined in src/ts/frontend/universe/darkKnight.ts:77