OBJECT

OptionDescriptor

Describes a single configuration option.

  • type OptionDescriptor {
  • # Describes the option in detail.
  • description: String!
  • # The human readable name of this option.
  • displayName: String!
  • # The option name as it is serialized into the configuration. This is different
  • # from the option key, and has none of the same guarantees, namely, uniqueness.
  • optionName: String!
  • # The string that uniquely identifies this option with regard to the section.
  • optionKey: String!
  • # Whether or not this option should be considered a 'simple' option to show to the
  • # user.
  • simple: Boolean!
  • # Whether or not tihs option should be showed to the user by default.
  • private: Boolean!
  • # Whether or not this option is a flag, meaning it is not serialized to the
  • # configuration file, and instead triggers some side effect.
  • isFlag: Boolean!
  • # Whether or not this option is a path option.
  • isPath: Boolean! @deprecated( reason: "Prefer using `optionType`." )
  • # Whether or not this option is a selection option.
  • isSelection: Boolean! @deprecated( reason: "Prefer using `optionType`." )
  • # The minimum value allowed if this option is a numeric option.
  • min: Float!
  • # The maximum value allowed if this option is a numeric option.
  • max: Float!
  • # The increment allowed if this option is a numeric option.
  • increment: Float!
  • # The type of value this option will take.
  • optionType: ConfigurationOptionType!
  • # If this option is a Path, the type of path value this option takes.
  • pathType: PathType!
  • # The default value of this option.
  • defaultValue: Any
  • # Gets a list of selection option descriptors if this option is an enum.
  • selectionDescriptors: [SelectionOptionDescriptor!]!
  • # Custom, plugin-defined metadata for this option, if any.
  • customMetadata: [OptionMetadata!]!
  • # If this option is a Path, the root path to begin browsing from. The format of
  • # this string is not exactly an `ContextualFilePath`. Instead, it is rooted
  • # (begins) at one of three roots
  • #
  • # * `game:/`, where the latter part of the path can be accessed with the query
  • # `game.filesystem`, for this game.
  • # * `common:/`, where the latter part of the path can be accessed with the query
  • # `plugin.provision.commonResourceDirectory`, for this orchestrator.
  • # * `plugin:/`, where the latter part of the path can be accessed with the query
  • # `plugin.provision.resourceDirectory`, for this orchestrator.
  • rootPath: String!
  • # If this option is a file path, the allowed file paths to show in the file
  • # browser.
  • filter: [String!]!
  • # If this option is a resource, the mimetype of the resource this option accepts.
  • resourceType: String!
  • }