Skip to content

InteractionVolumeInfo

Celestial Body Schema / Definitions / InteractionVolumeInfo
Schema Type: JSON Type: object

No Description Found

radius

Type: number Default: 1

The radius of this volume, if a shape is not specified.


shape

Type: ShapeInfo

The shape of this volume. Defaults to a sphere with a radius of `radius` if not specified.

See Definitions/ShapeInfo

rotation

Type: MVector3

Rotation of the object

See Definitions/MVector3

alignRadial

Type: boolean or null

Do we try to automatically align this object to stand upright relative to the body's center? Stacks with rotation.
Defaults to true for geysers, tornados, and volcanoes, and false for everything else.


position

Type: MVector3

Position of the object

See Definitions/MVector3

isRelativeToParent

Type: boolean

Whether the positional and rotational coordinates are relative to parent instead of the root planet object.


parentPath

Type: string

The relative path from the planet to the parent of this object. Optional (will default to the root sector).


rename

Type: string

An optional rename of this object


prompt

Type: string

The prompt to display when the volume is interacted with.


range

Type: number Default: 2

The range at which the volume can be interacted with.


maxViewAngle

Type: null or number

The max view angle (in degrees) the player can see the volume with to interact with it. This will effectively be a cone extending from the volume's center forwards (along the Z axis) based on the volume's rotation.
If not specified, no view angle restriction will be applied.


usableInShip

Type: boolean

Whether the volume can be interacted with while in the ship.


reusable

Type: boolean

Whether the volume can be interacted with multiple times.


condition

Type: string

The name of the dialogue condition or persistent condition to set when the volume is interacted with.


persistent

Type: boolean

If true, the condition will persist across all future loops until unset.


audio

Type: string

A sound to play when the volume is interacted with. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.


pathToAnimator

Type: string

A path to an animator component where an animation will be triggered when the volume is interacted with.


animationTrigger

Type: string

The name of an animation trigger to set on the animator when the volume is interacted with.