Table of Contents

Namespace Vintagestory.API

Classes

AddDocumentationPropertyAttribute

Adds a new property in the DocFX JSON documentation. Useful for attribute types which do not store JSON properties as variables. Properties need to be serializable by DocFX, hence why they're all strings. Sorry about that.

DocumentAsJsonAttribute

Specifies that this class or property should be inlcuded in the JSON-only documentation.
Has no functional use and can be ommited if the property is marked with [JsonProperty].
When using with enum types, only specify this attribute on the type itself, not each value.



Note that most fields will also contain the following inside their summary tag:
<jsonoptional>Optional</jsonoptional><jsondefault>None</jsondefault>



The attribute now has the ability to add in required, default, and attribute parameters. These will be analysed by the docFx plugin.