72 lines
2.0 KiB
Plaintext
72 lines
2.0 KiB
Plaintext
URL: https://wiki.studiominus.nl/internalReference/ModMetaData.html
|
|
Title: People Playground Modding - ModMetaData
|
|
==================================================
|
|
|
|
public class ModMetaData
|
|
[System.Serializable]
|
|
This class contains all information that describes one mod. This is usually created from a mod.json file.
|
|
Fields
|
|
public string Name
|
|
The displayed name of the mod
|
|
|
|
public string Author
|
|
The mod author
|
|
|
|
public string Description
|
|
The given description
|
|
|
|
public string RichReadme
|
|
[NonSerialized]
|
|
The contents of the README.md file converted to TMP rich tag format
|
|
|
|
public string ModVersion
|
|
The version of this mod
|
|
|
|
public string GameVersion
|
|
The game version
|
|
|
|
public string ThumbnailPath
|
|
The relative path from the mod.json file to the thumbnail
|
|
|
|
public string EntryPoint
|
|
The path to the entry point
|
|
|
|
public string[] Tags
|
|
An array of Workshop tags
|
|
|
|
public string[] Scripts
|
|
And array of paths to scripts
|
|
|
|
public bool Active
|
|
Should not be carelessly written to. Determines if the mod is active.
|
|
|
|
public string MetaLocation
|
|
[System.NonSerialized]
|
|
This is the directory in which the mod.json is stored
|
|
|
|
public string UGCIdentity
|
|
This stores the Workshop ID of the mod. Will be null if not applicable (not downloaded from the Workshop).
|
|
|
|
public string CreatorUGCIdentity
|
|
This stores the Workshop ID of the mod if it has been uploaded by the user. Will be null if not applicable (not uploaded to the Workshop). If you have copied a mod.json from somewhere, you probably want to remove this value from the file because it will prevent you from uploading it otherwise.
|
|
|
|
public string MetaPath
|
|
[System.NonSerialized]
|
|
The path to the mod.json file
|
|
|
|
public bool HasErrors
|
|
[System.NonSerialized]
|
|
Will be true if the mod failed to compile.
|
|
|
|
public string Errors
|
|
[System.NonSerialized]
|
|
Contains the error message if the mod failed to compile.
|
|
|
|
Properties
|
|
public bool Suspicious { get; internal set; }
|
|
[Newtonsoft.Json.JsonIgnore]
|
|
Was the mod marked as suspicious?
|
|
|
|
Methods
|
|
public (constructor) ModMetaData()
|
|
Constructs |