Difference between revisions of "Modding Key Terms"
DeamonHunter (Talk | contribs) (Initial commit.) |
DeamonHunter (Talk | contribs) (Added bool) |
||
| Line 3: | Line 3: | ||
| − | = | + | = Collection Types = |
== Blob == | == Blob == | ||
In terms of Staxel, "blob" is a generic term for anything that contains a number of properties. Blobs are always contained between <code> { } </code>. Every single new file you create is actually known as a blob, as each file will always start with <code>{</code> and end with <code>}</code> otherwise it would not work. | In terms of Staxel, "blob" is a generic term for anything that contains a number of properties. Blobs are always contained between <code> { } </code>. Every single new file you create is actually known as a blob, as each file will always start with <code>{</code> and end with <code>}</code> otherwise it would not work. | ||
| Line 33: | Line 33: | ||
| + | = Variable Types = | ||
== String == | == String == | ||
A string is anything that is a collection of letters. Strings can take any valid string characters, with only a couple exceptions. A string will always be encased in quotation marks. An example is provided below; | A string is anything that is a collection of letters. Strings can take any valid string characters, with only a couple exceptions. A string will always be encased in quotation marks. An example is provided below; | ||
| Line 39: | Line 40: | ||
"propertyName" : "This is a string. It allows anything that is normal text. Even, The quick brown fox jumped over the lazy dog." | "propertyName" : "This is a string. It allows anything that is normal text. Even, The quick brown fox jumped over the lazy dog." | ||
</pre> | </pre> | ||
| + | |||
| + | |||
| + | == Bool == | ||
| + | A Bool only has two values. These values are "True" or "False". These values, when used, are often used as toggles for certain features. When placed in a file they will look like; | ||
| + | <pre> | ||
| + | "thisIsATrueProperty" : true, | ||
| + | "thisIsAFalseProperty" : false | ||
| + | </pre> | ||
| + | |||
| + | As a note both True and true work, the same goes with False and false. | ||
Revision as of 09:11, 20 August 2017
This page is a list of key terms that are used often in modding pages. This page will be edited as more values appear.
Collection Types
Blob
In terms of Staxel, "blob" is a generic term for anything that contains a number of properties. Blobs are always contained between { } . Every single new file you create is actually known as a blob, as each file will always start with { and end with } otherwise it would not work.
In terms of what this means when modding. A blob is just a collection of properties that can be edited. Whenever this term comes up, just know that it will make use of { }.
List of [Blank]
When writing files, you'll occasionally be asked to make a list of items. What this means is that you can specify multiple things that will generally all act the same. This comes up most times whenever a file can do multiple things. Files such as Treasures make use of this type heavily.
When making lists you will need to do the following;
"propertyName" : [ item1, item2 ]
All lists start with a property name as usual. This is followed up by the opening square bracket. Square brackets always denote a list. With that you can now add items. In a lot of cases this will be #Strings that are seperated by commas. Each comma is needed to specify a new item will follow afterwards. (Though it is fine to have a final comma with no item.) After all of this, you can follow up with the closing square bracket to finish the list off.
An example of this would be;
"particles" : [ "staxel.particle.dirt.Dirt", "staxel.particle.dirt.Dirt2" ],
Variable Types
String
A string is anything that is a collection of letters. Strings can take any valid string characters, with only a couple exceptions. A string will always be encased in quotation marks. An example is provided below;
"propertyName" : "This is a string. It allows anything that is normal text. Even, The quick brown fox jumped over the lazy dog."
Bool
A Bool only has two values. These values are "True" or "False". These values, when used, are often used as toggles for certain features. When placed in a file they will look like;
"thisIsATrueProperty" : true, "thisIsAFalseProperty" : false
As a note both True and true work, the same goes with False and false.
