Skip to content

Commit c6e313b

Browse files
committed
document meta settings
1 parent 30d8f04 commit c6e313b

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

docs/en/manuals/project-settings.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -787,18 +787,48 @@ The default meta file that is always applied is available [here](https://github.
787787
The following attributes are currently available:
788788

789789
```
790-
// `type` - used for the value string parsing (only in bob.jar for now)
790+
[my_extension]
791+
// `type` - used for the value string parsing
791792
my_property.type = string // one of the following values: bool, string, number, integer, string_array, resource
792793
793794
// `help` - used as help tip in the editor (not used for now)
794795
my_property.help = string
795796
796-
// `default` - value used as default if user didn't set value manually (only in bob.jar for now)
797+
// `default` - value used as default if user didn't set value manually
797798
my_property.default = string
798799
799800
// `private` - private value used during the bundle process but will be removed from the bundle itself
800801
my_property.private = 1 // boolean value 1 or 0
801802
803+
// `label` - editor input label
804+
my_property.label = My Awesome Property
805+
806+
// `minimum` and/or `maximum` - valid range for numeric properties, validated in the editor UI
807+
my_property.minimum = 0
808+
my_property.maximum = 255
809+
810+
// `options` - drop-down choices for the editor UI, comma-separated value[:label] pairs
811+
my_property.options = android: Android, ios: iOS
812+
813+
// `resource` type only:
814+
my_property.filter = jpg,png // allowed file extensions for resource selector dialog
815+
my_property.preserve-extension = 1 // use original resource extension instead of a built one
816+
817+
// deprecation
818+
my_property.deprecated = 1 // mark property as deprecated
819+
my_property.severity-default = warning // if deprecated property is specified, but set to a default value
820+
my_property.severity-override = error // if deprecated property is specified and set to a non-default value
821+
822+
```
823+
Additionally, you can set the following attributes on a setting category:
824+
```
825+
[my_extension]
826+
// `group` - game.project category group, e.g. Main, Platforms, Components, Runtime, Distribution
827+
group = Runtime
828+
// `title` - displayed category title
829+
title = My Awesome Extension
830+
// `help` - displayed category help
831+
help = Settings for My Awesome Extension
802832
```
803833

804834

0 commit comments

Comments
 (0)