RevealVolumeInfo

Celestial Body Schema / Definitions / RevealVolumeInfo

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

---

# maxAngle

Type: number Default: 180

The max view angle (in degrees) the player can see the volume with to unlock the fact (`observe` only). This will effectively be a cone extending from the volume's center forwards (along the Z axis) based on the volume's rotation.

---

# maxDistance

Type: number Default: -1

The max distance the user can be away from the volume to reveal the fact (`snapshot` and `observe` only)

---

# revealOn

Type: RevealVolumeType Default: enter

What needs to be done to the volume to unlock the facts

See Definitions/RevealVolumeType

---

# revealFor

Type: EnterType Default: both

What can enter the volume to unlock the facts (`enter` only)

See Definitions/EnterType

---

# reveals

Type: array

A list of facts to reveal

# Items

Type: string

No Description Found

---

# achievementID

Type: string

An achievement to unlock. Optional.