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

    Class InspectablePropertyDecoration

    The InspectablePropertyDecoration class that contains all attributes declared on an InspectableProperty The properties are used to dynamically style or modify an InspectorField upon creation.

    Index
    allowedEnumValues: AllowedEnumValuesAttribute<any>
    asQuaternion: AsQuaternionAttribute

    The AsQuaternionAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    asSegmentedButton: AsSegmentedButtonAttribute

    The AsSegmentedButtonAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    category: CategoryAttribute

    The CategoryAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    checkBoxToggle: CheckBoxToggleAttribute

    The CheckBoxToggleAttribute changes how a read-only toggle is displayed.

    color: ColorAttribute
    conditionalVisibility: ConditionalVisibilityAttribute

    The ConditionalVisibilityAttribute dynamically determines if the field should be visible.

    confirmOnInteractionEnd: ConfirmOnInteractionEndAttribute

    The SignalOnInteractionEndAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    contentType: ContentTypeAttribute<Enum>

    The ContentTypeAttribute gets the content type used for filtering matching values in the UI.

    customFontAttribute: CustomFontAttribute
    customInspectorElements: CustomInspectorElementAttribute[]

    The CustomInspectorElementAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    decimals: DecimalsAttribute

    The DecimalsAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    defaultValue: DefaultValueAttribute

    The DefaultValueAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    developerOnly: DeveloperOnlyAttribute

    The DeveloperOnlyAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    dontLoadOnAssign: DontLoadOnAssignAttribute

    The DontLoadOnAssignAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    enumFlags: EnumFlagsAttribute

    The EnumFlagsAttribute determines whether an enum field should be displayed as a set of flags.

    featureToggle: FeatureToggleAttribute

    The FeatureToggleAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    fixedSizeArray: FixedSizeArrayAttribute

    The FixedSizeArrayAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    hdr: HDRAttribute

    The HDRAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    icon: IconAttribute

    The IconAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    immutable: ImmutableAttribute

    The ImmutableAttribute that determines if the field is immutable.

    includeImmutable: IncludeImmutableAttribute

    The IncludeImmutableAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    inline: InlineAttribute

    The InlineAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    isImmutableType: boolean

    Determines if the type is immutable.

    jsonObject?: JsonObjectAttribute

    The JsonObjectAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    layerMask: LayerMaskAttribute

    The LayerMaskAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    loadOnAssign: LoadOnAssignAttribute

    The LoadOnAssignAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    lockable: LockableAttribute

    The LockableAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    multiline: MultilineAttribute

    The MultilineAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    nameOverrideAttribute: FriendlyNameAttribute

    The NameOverrideAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    notNull: NotNullAttribute

    The NotNullAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    noUndoAttribute: NoUndoAttribute
    numberFormat: NumberFormatAttribute

    The NumberFormatAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    onDirtyReassignValue: OnDirtyReassignValueAttribute

    The OnDirtyReassignValueAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    order: OrderAttribute

    The OrderAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    range: RangeAttribute

    The RangeAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    sensitiveInformation: SensitiveInformationAttribute

    The SensitiveInformationAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    step: StepAttribute

    The StepAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    tooltip: DescriptionAttribute

    The TooltipAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    type: Type

    Determines the type that the property should be inspected as.

    typeArguments: Type[]

    Extra arguments that can be given to the type. If type is a ResourceHandle<T>, the arguments will point to the resource type held by the handle.

    usePresets: UsePresetsAttribute

    The UsePresetsAttribute value as defined by the user on the field description. Can also be manually defined by the user when adding custom fields to an inspector.

    • get customFont(): Font

      The custom font.

      Returns Font

    • get customFontSize(): number

      The custom font size.

      Returns number

    • get hasContentType(): boolean

      Determines if the field has a content type for additional filtering.

      Returns boolean

    • get isAsLayerMask(): boolean

      Integer field should be represented as a layer mask drop down instead of a plain integer input field.

      Returns boolean

    • get isAsQuaternion(): boolean

      When a quaternion is displayed in the inspector, by default it will be displayed as converted into euler angles. Use this flag to force it to be displayed as a quaternion (4D value) with no conversion instead.

      Returns boolean

    • get isAsSegmentedButton(): boolean

      Indicates that an enum field should be rendered as a segmented button.

      Returns boolean

    • get isAsSlider(): boolean

      Floating point field should be represented as a slider rather than a plain input field.

      Returns boolean

    • get isColor(): boolean

      Determines if the property value should be represented as a color value.

      Returns boolean

    • get isContentTypeEnforced(): boolean

      Whenther the content type should be enforced.

      Returns boolean

    • get isDeveloperOnly(): boolean

      The field will be hidden on inspectors if the developer mode is not enabled.

      Returns boolean

    • get isDontLoadOnAssign(): boolean

      Signifies that a ResourceHandle<T> should not be loaded when assigned to field through the inspector.

      Returns boolean

    • get isEnumFlags(): boolean

      Determines whether an enum field should be displayed as a set of flags.

      Returns boolean

    • get isFeatureTogglePresent(): boolean

      Indicates that a is a toggle for it's entire structure.

      Returns boolean

    • get isFilteringEnumValues(): boolean

      Determines whether the enum field should filter its displayed values.

      Returns boolean

    • get isFixedSizeArray(): boolean

      Indicates that the contained array has a fixed size and operations that change the size of the array shouldn't be available.

      Returns boolean

    • get isHDR(): boolean

      Specifies that a Color is allowed to have a value outside of the [0, 1] range.

      Returns boolean

    • get isIcon(): boolean

      The field has an icon associated with it. This icon can be used when showing on the UI.

      Returns boolean

    • get isInCategory(): boolean

      Determines if the field is inside a category or not.

      Returns boolean

    • get isIncludingImmutable(): boolean

      If set, immutable fields should be shown.

      Returns boolean

    • get isInline(): boolean

      Signifies that the field containing a class/struct should display the child fields of that objects as if they were part of the parent class in the inspector.

      Returns boolean

    • get isJsonObject(): boolean

      Displays an object as json tree in the inspector.

      Returns boolean

    • get isLoadOnAssign(): boolean

      Signifies that a ResourceHandle<T> should be loaded when assigned to field through the inspector.

      Returns boolean

    • get isLockable(): boolean

      If set, the field can be locked, applicable for vector fields.

      Returns boolean

    • get isMultiline(): boolean

      Indicates that the text field should support multiple lines.

      Returns boolean

    • get isNotNull(): boolean

      Object returned by the inspectable field will never be null, and null should never be passed to the field. Only relevant if a field type is a reference type.

      Returns boolean

    • get isOnDirtyReassignValue(): boolean

      When a field changes those changes need to be applied to the parent object by calling the field setter.

      Returns boolean

    • get isOrdered(): boolean

      Determines if the field is manually ordered.

      Returns boolean

    • get isSensitiveInformation(): boolean

      Indicates that the text field should mask sensitive information.

      Returns boolean

    • get isTooltip(): boolean

      Indicates that a field has a Tooltip attribute to be shown within the UI.

      Returns boolean

    • get isUsingCustomCheckBoxToggleIcons(): boolean

      Returns whether a custom checkbox toggle icon attribute is being used.

      Returns boolean

    • get isUsingPresets(): boolean

      If set, the field will use presets.

      Returns boolean

    • get nameOverride(): string

      The name of the field to be displayed on the UI inspector.

      Returns string

    • get noUndo(): boolean

      Returns boolean

    • Gets the type argument at the given index. If no such type parameter exists, fallback is returned.

      Parameters

      • index: number

        The index of the type argument to be fetched.

      • Optionalfallback: Type

        The fallback value returned in case index is not present on the type arguments array.

      Returns Type

      Either the type argument at index or fallback in case it doesn't exist.

    • Determines if the object is currently visible..

      Parameters

      • object: any

      Returns boolean

    • Creates a new InspectablePropertyStyle from the given field or property on type;

      Parameters

      • type: Type

        The type to fetch attributes from.

      • name: string

        The name of the field or property to get the style information from.

      Returns InspectablePropertyDecoration

      The InspectablePropertyStyle instance for the given field or property, null if the field or property is not an inspectable property.