Modding Key Terms - Revision history

DeamonHunter: /* Vector 3 */ Add vector 2.

2017-09-20T10:39:09Z

‎Vector 3: Add vector 2.

DeamonHunter: /* Variable Types */ Added colour to modding key terms.

2017-08-23T11:52:27Z

‎Variable Types: Added colour to modding key terms.

DeamonHunter: /* List of [Blank] */

2017-08-23T09:33:14Z

‎List of [Blank]

DeamonHunter: /* Variable Types */

2017-08-20T13:47:33Z

‎Variable Types

DeamonHunter: Added bool

2017-08-20T13:11:35Z

Added bool

DeamonHunter: Initial commit.

2017-08-20T13:01:17Z

Initial commit.

New page

[[Category:Modding]]
This page is a list of key terms that are used often in modding pages. This page will be edited as more values appear.

= Variable Types =
== 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 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 <code>{ }</code>.

== 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;
<pre>
"propertyName" : [
item1,
item2
]
</pre>

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;
<pre>
"particles" : [
"staxel.particle.dirt.Dirt",
"staxel.particle.dirt.Dirt2"
],
</pre>

== 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;

<pre>
"propertyName" : "This is a string. It allows anything that is normal text. Even, The quick brown fox jumped over the lazy dog."
</pre>

@@ Line 90: / Line 90: @@
 <pre>
 "propertyName" : { "x": 0.0, "y": 0.0, "z": 0.0 }
 </pre>
 Note that the numbers can change depending on the type. They can be [[#Integer|Integers]], [[#Float|Floats]] or [[#Double|Doubles]]. Each of these are just slightly different from each other.

← Older revision		Revision as of 13:47, 20 August 2017
Line 50:		Line 50:

	As a note both True and true work, the same goes with False and false.		As a note both True and true work, the same goes with False and false.
		+
		+
		+	== Integer ==
		+	An integer is a number that has no decimal part, otherwise known as a whole number. These will look like the following;
		+	<pre>
		+	"propertyName" : 1,
		+	</pre>
		+
		+	Note that when a integer is specified, you cannot have decimal numbers. This is not the same in reverse (e.g. An integer can be used in [[#Float]])
		+
		+
		+	== Float ==
		+	An float is a number that has decimal part, otherwise known as a decimal number. These will look like the following;
		+	<pre>
		+	"propertyName" : 1.5,
		+	</pre>
		+
		+	Note that there is a maximum precision to a float, which is roughly 7 digits of precision. Also note that convention means that integer numbers will still have <code>.0</code> afterwards to make sure that it is clear.
		+
		+	For more information on what a Float actually is, look up scientific notation. Floats are the computer equivalent to scientific notation.
		+
		+
		+	== Double ==
		+	An double is exactly the same as a [[#Float]] but with one change. A Double has about 16 digits of precision, which is much more than float's roughly 7 digits of precision.
		+
		+
		+	== Vector 3==
		+	A Vector 3, is a mathematical term for an object that has 3 numbers. Vectors are used most often when specifying a location in Staxel's world. All Vector 3's come in the following form;
		+	<pre>
		+	"propertyName" : { "x": 0.0, "y": 0.0, "z": 0.0 }
		+	</pre>
		+
		+	Note that the numbers can change depending on the type. They can be [[#Integer\|Integers]], [[#Float\|Floats]] or [[#Double\|Doubles]]. Each of these are just slightly different from each other.

@@ Line 38: / Line 38: @@
 <pre>
 "propertyName" : "This is a string. It allows anything that is normal text. Even, The quick brown fox jumped over the lazy dog."
 </pre>

@@ Line 11: / Line 11: @@
-== List of [Blank] ==
+== List ==
 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.
@@ Line 31: / Line 31: @@
 ],
 </pre>
 = Variable Types =

@@ Line 3: / Line 3: @@
-= Variable Types =
+= 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 <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: @@
 == 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;
@@ 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."
 </pre>