Modding Designs

From wiki
Jump to: navigation, search

This page is not really intended to be used for general public, but to act as a storage for default formats in the staxel wiki. I should have done this earlier in order to avoid copy paste problems.

Default Value

For stuff with no default.

Default Value: No default value is specified. Always need to provide your own.

For stuff with a default.

Default Value: If not specified, blah.


Useful Components

Short reasoning why you would want components for this thing.

Component page name

Explanation of the component and why it is useful

For more information on how to use the [Component Name], head to Component page name#When and How to use.


Useful Components [No useful components]

[Page] do not have any useful components at this point in time. The only options are those provided by the #Config Options section.


Variable Defaults

"code"

Valid options (String): A unique string which identifies what [Page] this is.

Default Value: No default value is specified. Always need to provide your own.


This option is required to uniquely identify any object or resource. This string must be unique to all other codes, but does not have any other requirements.


Generic String

Valid options (String): Any valid String.

Default Value: No default value is specified. Always need to provide your own.


[Explanation of the property]


Generic String that contains a code

Valid options (String): A string containing the code to a page file.

Default Value: If not specified, will not play any action while crafting.


[Explanation of the property]


List of Strings

Valid options (List of String ): A list of strings containing the name of any site in this dock.

Default Value: No default value is specified. Always need to provide your own.


[Explanation of the property]


Bool

Valid options (Bool): True or False

Default Value: No default value is specified. Always need to provide your own.


[Explanation of the property]


Vector 3

Valid options (Vector 3 - Number Type): { "x": 0, "y": 0, "z": 0 }

Default Value: If not specified, will not play any action while crafting.


[Explanation of the property]