Interface ICoreAPICommon
- Namespace
- Vintagestory.API.Common
- Assembly
- VintagestoryAPI.dll
API Methods common to the server and client
public interface ICoreAPICommon- Extension Methods
Properties
DataBasePath
Returns the root path of the games data folder
string DataBasePath { get; }Property Value
ObjectCache
Can be used to store non-persistent, game wide data. E.g. used for firewood piles to pregenerate all meshes only once during startup
Dictionary<string, object> ObjectCache { get; }Property Value
Methods
GetOrCreateDataPath(string)
Returns the path to given foldername inside the games data folder. Ensures that the folder exists
string GetOrCreateDataPath(string foldername)Parameters
foldernamestring
Returns
LoadModConfig(string)
Loads a config file from a prepared modconfig folder, you only need to provide a unique filename. Recommendation: Surround this call with a try/catch in case the user made a typo while changing the configuration Be aware that these configs are not synchronized between client and server. Each side will store their own copy of the configuration. If these configs affect gameplay, you will likely need to synchronize it to client via network packet Returns null if the file does not exist
JsonObject LoadModConfig(string filename)Parameters
filenamestring
Returns
LoadModConfig<T>(string)
Loads a config file from a prepared modconfig folder, you only need to provide a unique filename. Recommendation: Surround this call with a try/catch in case the user made a typo while changing the configuration Be aware that these configs are not synchronized between client and server. Each side will store their own copy of the configuration. If these configs affect gameplay, you will likely need to synchronize it to client via network packet Returns null if the file does not exist
T LoadModConfig<T>(string filename)Parameters
filenamestring
Returns
- T
Type Parameters
T
RegisterBlockBehaviorClass(string, Type)
Register a new block behavior class. Must happen before any blocks are loaded. Be sure to register it on the client and server side.
void RegisterBlockBehaviorClass(string className, Type blockBehaviorType)Parameters
RegisterBlockClass(string, Type)
Register a new Blockclass. Must happen before any blocks are loaded. Be sure to register it on the client and server side.
void RegisterBlockClass(string className, Type blockType)Parameters
RegisterBlockEntityBehaviorClass(string, Type)
Register a new block entity behavior class. Must happen before any blocks are loaded. Be sure to register it on the client and server side.
void RegisterBlockEntityBehaviorClass(string className, Type blockEntityBehaviorType)Parameters
RegisterBlockEntityClass(string, Type)
Register a new BlockEntity Class. Must happen before any blocks are loaded. Be sure to register it on the client and server side.
void RegisterBlockEntityClass(string className, Type blockentityType)Parameters
RegisterCollectibleBehaviorClass(string, Type)
Registers a new collectible behavior class, which can be used for items or for blocks.
void RegisterCollectibleBehaviorClass(string className, Type blockBehaviorType)Parameters
RegisterColorMap(ColorMap)
Registers a new color map. Typically used to color in-game blocks with a texture - i.e. climate and seasonal coloring
void RegisterColorMap(ColorMap map)Parameters
mapColorMap
RegisterCropBehavior(string, Type)
Register a new crop behavior
void RegisterCropBehavior(string className, Type type)Parameters
RegisterEntity(string, Type)
Registers a non-block entity. Be sure to register it on the client and server side.
void RegisterEntity(string className, Type entity)Parameters
RegisterEntityBehaviorClass(string, Type)
Registers a non-block entity behavior. Be sure to register it on the client and server side.
void RegisterEntityBehaviorClass(string className, Type entityBehavior)Parameters
RegisterItemClass(string, Type)
Register a new Item Class. Must happen before any blocks are loaded. Be sure to register it on the client and server side.
void RegisterItemClass(string className, Type itemType)Parameters
RegisterMountable(string, GetMountableDelegate)
Register a new block behavior class. Must happen before any blocks are loaded. Be sure to register it on the client and server side. Make your your delegate also set tree.SetString("className", "[your className]");
void RegisterMountable(string className, GetMountableDelegate mountableInstancer)Parameters
classNamestringmountableInstancerGetMountableDelegate
RegisterRecipeRegistry<T>(string)
Registers a recipe registry
T RegisterRecipeRegistry<T>(string recipeRegistryCode) where T : RecipeRegistryBaseParameters
recipeRegistryCodestring
Returns
- T
Type Parameters
T
StoreModConfig(JsonObject, string)
Stores a config file in a prepared modconfig folder. You only need to provide a unique filename. Be aware that these configs are not synchronized between client and server. Each side will store their own copy of the configuration. If these configs affect gameplay, you will likely need to synchronize it to client it via network packet
void StoreModConfig(JsonObject jobj, string filename)Parameters
jobjJsonObjectfilenamestring
StoreModConfig<T>(T, string)
Stores a config file in a prepared modconfig folder. You only need to provide a unique filename. For T just make a class with all fields public - this is your configuration class. Be sure to set useful default values for your settings Be aware that these configs are not synchronized between client and server. Each side will store their own copy of the configuration. If these configs affect gameplay, you will likely need to synchronize it via network packet
void StoreModConfig<T>(T jsonSerializeableData, string filename)Parameters
jsonSerializeableDataTfilenamestring
Type Parameters
T