RSX Code Reference
    Preparing search index...

    Function preferencesPanel

    • An decorator that must be used in classes that implement PreferencesPanel in order for them to be recognized by the UserSettingsWindow.

      This decorator holds information such as the panel displayName, icon and the order in which it should be visible on the tab bar.

      The optional isActive parameter can determine if the settings panel should be shown or not. If it is set to undefined, the panel is always visible. Project specific panels should implement a delegate that determines if the project is loaded:

       	() => Project.isLoaded
      

      Parameters

      • displayName: string
      • icon: EnumValue<StockIcon>
      • order: number
      • OptionalisActive: () => boolean

      Returns AttributeDecorator<Attribute>