RSX Code Reference
    Preparing search index...
    • rsx
    • InspectableField

    Class InspectableField<T>

    The InspectableField provides access meta-data about fields in an object. The primary use-case for this class is type reflection within the Inspector APIs.

    Type Parameters

    • T extends object = any
    Index
    get: () => any

    Gets the value from the field.

    Type Declaration

      • (): any
      • Returns any

        The field on the property or undefined if the value could not be retrieved.

    name: string

    The name of the field.

    The parent object that contains the field.

    reflectionMember: ReflectionMember

    The ReflectionMember that is being inspected.

    set: (value: any) => boolean

    Sets a new value for the field.

    Type Declaration

      • (value: any): boolean
      • Parameters

        • value: any

          The new value of the field.

        Returns boolean

        true if the field was set successfully

    If the parent object has the reassignOnChildChanges flag set, the parent will be property will be reapplied.

    All attributes of the inspector field. Determines how the field show be viewed.