About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface ModProperty<T>

Represents a property owned by the Mod Visualization. The Mod manifest defines the properties owned by the Mod Visualization.

interface ModProperty<T extends ModPropertyDataType = ModPropertyDataType> {
    name: string;
    set(value: T): void;
    value<T2 extends ModPropertyDataType>(): null | T2;
}

Type Parameters

T extends ModPropertyDataType = ModPropertyDataType

Hierarchy (View Summary)

ModPropertyValue<T>
- ModProperty

Index

Properties

Methods

Properties

name

name: string

Gets the name of this instance.

Methods

set

set(value: T): void
Set the value of this instance.
Parameters
- value: T
  The value to set.
Returns void

value

value<T2 extends ModPropertyDataType>(): null | T2
Gets the value held by this instance;
Type Parameters
- T2 extends ModPropertyDataType
Returns null | T2
Inherited from ModPropertyValue.value