Modding:Template Property Type: Difference between revisions

From Vintage Story Wiki
(Created property template page.)
 
m (Created template page for property references.)
Line 3: Line 3:
__TOC__
__TOC__
=== Usage ===
=== Usage ===
The '''MusicConfig''' property type is a '''content-type''' used to add new music tracks to Vintage Story. Any number of mods can add new tracks, however the ''properties'' element will only load from one mod. Because of this, it is not recommended to add the ''properties'' element to your mod.
The '''propertyname''' property type is a '''content-type/sub-type/enum-type/simple-type''' used to <usage>.  


MusicConfig files must be created as "''music/musicconfig.json''" in a mod's domain folder for them to be loaded.
<If Content-Type> PropertyName files must be created as "''path/to/propertytype.json''" in a mod's domain folder for them to be loaded.


The script for MusicConfig is currently not available on GitHub.  
The script for propertyname can be found on GitHub.
 
The script for propertyname is currently not available on GitHub, but can be found at "''namespace.of.property.Type"'' in decompiled source code.


=== Property Reference ===
=== Property Reference ===
Line 15: Line 17:
!Description
!Description
|-
|-
|Properties
|
|{{Proptype|MusicConfigProperties}}
|
|Defines some properties for controlling the music engine. It is recommended to not include this in a mod.
|
|-
|-
|Tracks
|
|{{Proptype|Array}} ({{Proptype|SurfaceMusicTrack}} or {{Proptype|CaveMusicTrack}})
|
|A list of music track properties, one entry per track.
|
|}
|}



Revision as of 11:22, 26 April 2024

Usage

The propertyname property type is a content-type/sub-type/enum-type/simple-type used to <usage>.

<If Content-Type> PropertyName files must be created as "path/to/propertytype.json" in a mod's domain folder for them to be loaded.

The script for propertyname can be found on GitHub.

The script for propertyname is currently not available on GitHub, but can be found at "namespace.of.property.Type" in decompiled source code.

Property Reference

Property ID Type Description

Example

path/to/property/example.json
{
	Example Code Here.
}
JSON Properties - Audio
Content Types MusicConfig SoundConfig
Sub-Types Empty
Enum Types Empty
JSON Properties - Game Objects
Content Types BlockType CollectibleType EntityType ItemType RegistryObjectType
Sub-Types Empty
Enum Types Empty
JSON Properties - Patches
Content Types JsonPatch
Sub-Types Empty
Enum Types Empty
JSON Properties - Recipes
Content Types AlloyRecipe BarrelRecipe ClayFormingRecipe CookingRecipe GridRecipe KnappingRecipe LayeredVoxelRecipe RecipeBase SmithingRecipe
Sub-Types Empty
Enum Types Empty
JSON Properties - World Properties
Content Types StandardWorldProperty WorldPropertyVariant
Sub-Types Empty
Enum Types Empty
Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository

Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository