OBJECT
OptionDescriptor
Describes a single configuration option.
- type OptionDescriptor {
- # Describes the option in detail.
- String! :
- # The human readable name of this option.
- 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.
- String! :
- # The string that uniquely identifies this option with regard to the section.
- String! :
- # Whether or not this option should be considered a 'simple' option to show to the
- # user.
- Boolean! :
- # Whether or not tihs option should be showed to the user by default.
- Boolean! :
- # Whether or not this option is a flag, meaning it is not serialized to the
- # configuration file, and instead triggers some side effect.
- Boolean! :
- # Whether or not this option is a path option.
- Boolean! @deprecated( reason: "Prefer using `optionType`." ) :
- # Whether or not this option is a selection option.
- Boolean! @deprecated( reason: "Prefer using `optionType`." ) :
- # The minimum value allowed if this option is a numeric option.
- Float! :
- # The maximum value allowed if this option is a numeric option.
- Float! :
- # The increment allowed if this option is a numeric option.
- Float! :
- # The type of value this option will take.
- ConfigurationOptionType! :
- # If this option is a Path, the type of path value this option takes.
- PathType! :
- # The default value of this option.
- Any :
- # Gets a list of selection option descriptors if this option is an enum.
- SelectionOptionDescriptor!]! : [
- # Custom, plugin-defined metadata for this option, if any.
- 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.
- String! :
- # If this option is a file path, the allowed file paths to show in the file
- # browser.
- String!]! : [
- # If this option is a resource, the mimetype of the resource this option accepts.
- String! :
- }