@@ -21,7 +21,7 @@ This class provides functionality for working with per-mod Configurations.
21
21
22
22
## Methods
23
23
### create_config
24
- ``` gdscript
24
+ ``` gdscript2
25
25
func create_config(mod_id: String, config_name: String, config_data: Dictionary) -> ModConfig
26
26
```
27
27
Creates a new configuration for a mod.
@@ -36,7 +36,7 @@ Returns:
36
36
37
37
38
38
### update_config
39
- ``` gdscript
39
+ ``` gdscript2
40
40
func update_config(config: ModConfig) -> ModConfig
41
41
```
42
42
Updates an existing ModConfig object with new data and save the config file.
@@ -49,7 +49,7 @@ Returns:
49
49
50
50
51
51
### delete_config
52
- ``` gdscript
52
+ ``` gdscript2
53
53
func delete_config(config: ModConfig) -> bool
54
54
```
55
55
Deletes a ModConfig object and performs cleanup operations.
@@ -62,7 +62,7 @@ Returns:
62
62
63
63
64
64
### set_current_config
65
- ``` gdscript
65
+ ``` gdscript2
66
66
func set_current_config(config: ModConfig) -> void
67
67
```
68
68
Sets the current configuration of a mod to the specified configuration.
@@ -72,7 +72,7 @@ Parameters:
72
72
73
73
74
74
### get_config_schema
75
- ``` gdscript
75
+ ``` gdscript2
76
76
func get_config_schema(mod_id: String) -> Dictionary
77
77
```
78
78
Returns the schema for the specified mod id. If no configuration file exists for the mod, an empty dictionary is returned.
@@ -85,7 +85,7 @@ Returns:
85
85
86
86
87
87
### get_schema_for_prop
88
- ``` gdscript
88
+ ``` gdscript2
89
89
func get_schema_for_prop(config: ModConfig, prop: String) -> Dictionary
90
90
```
91
91
Retrieves the schema for a specific property key.
@@ -99,7 +99,7 @@ Returns:
99
99
100
100
101
101
### get_mods_with_config
102
- ``` gdscript
102
+ ``` gdscript2
103
103
func get_mods_with_config() -> Array
104
104
```
105
105
Retrieves an Array of mods that have configuration files.
@@ -109,7 +109,7 @@ Returns:
109
109
110
110
111
111
### get_configs
112
- ``` gdscript
112
+ ``` gdscript2
113
113
func get_configs(mod_id: String) -> Dictionary
114
114
```
115
115
Retrieves the configurations dictionary for a given mod ID.
@@ -122,7 +122,7 @@ Returns:
122
122
123
123
124
124
### get_config
125
- ``` gdscript
125
+ ``` gdscript2
126
126
func get_config(mod_id: String, config_name: String) -> ModConfig
127
127
```
128
128
Retrieves the configuration for a specific mod and configuration name. Returns the configuration as a ModConfig object or null if not found.
@@ -136,7 +136,7 @@ Returns:
136
136
137
137
138
138
### get_default_config
139
- ``` gdscript
139
+ ``` gdscript2
140
140
func get_default_config(mod_id: String) -> ModConfig
141
141
```
142
142
Retrieves the default configuration for a specified mod ID.
@@ -149,7 +149,7 @@ Returns:
149
149
150
150
151
151
### get_current_config
152
- ``` gdscript
152
+ ``` gdscript2
153
153
func get_current_config(mod_id: String) -> ModConfig
154
154
```
155
155
Retrieves the currently active configuration for a specific mod
@@ -162,7 +162,7 @@ Returns:
162
162
163
163
164
164
### get_current_config_name
165
- ``` gdscript
165
+ ``` gdscript2
166
166
func get_current_config_name(mod_id: String) -> String
167
167
```
168
168
Retrieves the name of the current configuration for a specific mod Returns an empty string if no configuration exists for the mod or the user profile has not been loaded
@@ -176,12 +176,12 @@ Returns:
176
176
177
177
## Constants Descriptions
178
178
##### DEFAULT_CONFIG_NAME
179
- ``` gdscript
179
+ ``` gdscript2
180
180
const DEFAULT_CONFIG_NAME: String = "default"
181
181
```
182
182
183
183
184
184
##### LOG_NAME
185
- ``` gdscript
185
+ ``` gdscript2
186
186
const LOG_NAME: String = "ModLoader:Config"
187
187
```
0 commit comments