Skip to content

Commit d4d0b95

Browse files
committed
Add the name of the class to the class phrase
1 parent d1fa6ef commit d4d0b95

11 files changed

+14
-14
lines changed

doc/files/JSON-CONFIG-FILE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The main class of this plugin. This class would read the user input file, detect
44

55
## Usage
66

7-
First, once you have instantiated the class, you can add new properties by using the 'add_property' method, which requires the property name and a JSONProperty object as its parameters. By default, any new property is obligatory. If you want to make it optional, you must include 'false' as the third parameter. The fourth parameter is the default value that the property would take if the input does not specify this property. Any default value must pass the tests of this property. Otherwise, it would not be accepted.
7+
First, once you have instantiated the 'JSONConfigFile' class, you can add new properties by using the 'add_property' method, which requires the property name and a JSONProperty object as its parameters. By default, any new property is obligatory. If you want to make it optional, you must include 'false' as the third parameter. The fourth parameter is the default value that the property would take if the input does not specify this property. Any default value must pass the tests of this property. Otherwise, it would not be accepted.
88

99
After adding all the properties, you can create exclusivity and dependency relationships between them. You can not establish these relations with obligatory properties, so every property must be optional.
1010

doc/files/JSON-CONFIG-PROCESSOR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JSONConfigProcessors
1+
# JSONConfigProcessor
22

33
Is an abstract class from which any custom process must extend. The functionality of this class is a bit advanced, but basically, it serves as a way to create functions to process the user input before or after the property tests.
44

doc/files/JSON-PROPERTY-ARRAY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JSON Property Array
1+
# JSONPropertyArray
22

33
**extends [JSONProperty](./JSON-PROPERTY.md)**
44

@@ -8,7 +8,7 @@ Only allows arrays.
88

99
## Usage
1010

11-
Once you have instantiated the class, you can set restrictions on the size of the array via the 'set_min_size' and 'set_max_size' methods. The values that these functions receive as parameters are inclusive. To remove any restriction, you can use the 'remove_min_size' and 'remove_max_size' methods.
11+
Once you have instantiated the 'JSONPropertyArray' class, you can set restrictions on the size of the array via the 'set_min_size' and 'set_max_size' methods. The values that these functions receive as parameters are inclusive. To remove any restriction, you can use the 'remove_min_size' and 'remove_max_size' methods.
1212

1313
You can also determine what kind of elements can be part of this array via the 'set_element_property' method, which receives a JSONProperty object as a parameter. Otherwise, the array would accept any type of data. You can return to the default behavior using the 'remove_element_property'.
1414

doc/files/JSON-PROPERTY-ENUM.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Only allows strings from an array of possible values.
88

99
## Usage
1010

11-
Once you have instantiated the class, you must provide an array with the possible values via the 'set_enum' method. Otherwise, it would not allow anything at all.
11+
Once you have instantiated the 'JSONPropertyEnum' class, you must provide an array with the possible values via the 'set_enum' method. Otherwise, it would not allow anything at all.
1212

1313
## Example
1414

doc/files/JSON-PROPERTY-FILE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Only allows strings representing a path to a file. This path can be absolute or
88

99
## Usage
1010

11-
Once you have instantiated the class, you can determine how to open the file via the 'set_mode_flag' method. It would be [File.READ](https://docs.godotengine.org/en/stable/classes/class_file.html?highlight=File.READ#enumerations) by default.
11+
Once you have instantiated the 'JSONPropertyFile' class, you can determine how to open the file via the 'set_mode_flag' method. It would be [File.READ](https://docs.godotengine.org/en/stable/classes/class_file.html?highlight=File.READ#enumerations) by default.
1212

1313
## Example
1414

doc/files/JSON-PROPERTY-IMAGE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Only allows strings representing a path to an image. This path can be absolute o
88

99
## Usage
1010

11-
Once you have instantiated the class, you can determine the size of the image via the 'set_size' method. By default, the images would be resizable and rescaled using [Image.INTERPOLATE_BILINEAR](https://docs.godotengine.org/en/stable/classes/class_image.html?highlight=Image#enum-image-interpolation). That means that when the image size is different, this property will raise a warning. If you want it to raise an error, set the third parameter in 'set_size' to 'false'.
11+
Once you have instantiated the 'JSONPropertyImage' class, you can determine the size of the image via the 'set_size' method. By default, the images would be resizable and rescaled using [Image.INTERPOLATE_BILINEAR](https://docs.godotengine.org/en/stable/classes/class_image.html?highlight=Image#enum-image-interpolation). That means that when the image size is different, this property will raise a warning. If you want it to raise an error, set the third parameter in 'set_size' to 'false'.
1212

1313
## Example
1414

doc/files/JSON-PROPERTY-INTEGER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Only allows integers.
88

99
## Usage
1010

11-
Once you have instantiated the class, you can set the boundaries of the possible values via the 'set_min_value' and 'set_max_value' methods. The values that these functions receive as parameters are inclusive. To remove any boundary you can use the 'remove_min_value' and 'remove_max_value' methods.
11+
Once you have instantiated the 'JSONPropertyInteger' class, you can set the boundaries of the possible values via the 'set_min_value' and 'set_max_value' methods. The values that these functions receive as parameters are inclusive. To remove any boundary you can use the 'remove_min_value' and 'remove_max_value' methods.
1212

1313
## Example
1414

doc/files/JSON-PROPERTY-JSON-CONFIG-FILE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JSONPropertyJSONConfigurationFile
1+
# JSONPropertyJSONConfigFile
22

33
**extends [JSONProperty](./JSON-PROPERTY.md)**
44

@@ -8,7 +8,7 @@ Only allows strings representing a path to a JSON configuration file. This path
88

99
## Usage
1010

11-
Once you have instantiated the class, you must determine which JSONConfigFile this property would use via the 'set_json_config_file' method.
11+
Once you have instantiated the 'JSONPropertyJSONConfigFile' class, you must determine which JSONConfigFile this property would use via the 'set_json_config_file' method.
1212

1313
## Example
1414

doc/files/JSON-PROPERTY-NUMBER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Only allows real numbers.
88

99
## Usage
1010

11-
Once you have instantiated the class, you can set the boundaries of the possible values via the 'set_min_value' and 'set_max_value' methods. The values that these functions receive as parameters are inclusive. To remove any boundary you can use the 'remove_min_value' and 'remove_max_value' methods.
11+
Once you have instantiated the 'JSONPropertyNumber' class, you can set the boundaries of the possible values via the 'set_min_value' and 'set_max_value' methods. The values that these functions receive as parameters are inclusive. To remove any boundary you can use the 'remove_min_value' and 'remove_max_value' methods.
1212

1313
## Example
1414

doc/files/JSON-PROPERTY-OBJECT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# JSON Property Object
1+
# JSONPropertyObject
22

33
**extends [JSONProperty](./JSON-PROPERTY.md)**
44

@@ -8,7 +8,7 @@ Only allows dictionaries.
88

99
## Usage
1010

11-
First, once you have instantiated the class, you can add new properties by using the 'add_property' method, which requires the property name and a JSONProperty object as its parameters. By default, any new property is obligatory. If you want to make it optional, you must include 'false' as the third parameter. The fourth parameter is the default value that the property would take if the input does not specify this property. Any default value must pass the tests of this property. Otherwise, it would not be accepted.
11+
First, once you have instantiated the 'JSONPropertyObject' class, you can add new properties by using the 'add_property' method, which requires the property name and a JSONProperty object as its parameters. By default, any new property is obligatory. If you want to make it optional, you must include 'false' as the third parameter. The fourth parameter is the default value that the property would take if the input does not specify this property. Any default value must pass the tests of this property. Otherwise, it would not be accepted.
1212

1313
After adding all the properties, you can create exclusivity and dependency relationships between them. You can not establish these relations with obligatory properties, so every property must be optional.
1414

0 commit comments

Comments
 (0)