Welcome to the Vintage St
This is just a reference doc
If you want to learn how to mod the game, check out the tutorials on the Official Vintage Story Wiki, this site merely acts as a reference documentation to look stuff up on
-Reference doc for game version 1.19.4-rc.3
+Reference doc for game version 1.19.4
diff --git a/docs/index.json b/docs/index.json
index 1c1fb7b1..1d08f3cf 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -1192,7 +1192,7 @@
"api/Vintagestory.API.Client.Matrixf.html": {
"href": "api/Vintagestory.API.Client.Matrixf.html",
"title": "Class Matrixf | VintageStory API",
- "keywords": "Class Matrixf Namespace Vintagestory.API.Client Assembly VintagestoryAPI.dll public class Matrixf Inheritance object Matrixf Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors Matrixf() public Matrixf() Fields Values public float[] Values Field Value float[] Properties ValuesAsDouble public double[] ValuesAsDouble { get; } Property Value double[] Methods Clone() public Matrixf Clone() Returns Matrixf Create() public static Matrixf Create() Returns Matrixf FollowPlayer() public Matrixf FollowPlayer() Returns Matrixf FollowPlayerXZ() public Matrixf FollowPlayerXZ() Returns Matrixf Identity() public Matrixf Identity() Returns Matrixf Invert() public Matrixf Invert() Returns Matrixf Mul(float[]) public Matrixf Mul(float[] matrix) Parameters matrix float[] Returns Matrixf ReverseMul(float[]) public Matrixf ReverseMul(float[] matrix) Parameters matrix float[] Returns Matrixf Rotate(float, float, float) public Matrixf Rotate(float radX, float radY, float radZ) Parameters radX float radY float radZ float Returns Matrixf Rotate(Vec3f) public Matrixf Rotate(Vec3f radians) Parameters radians Vec3f Returns Matrixf RotateDeg(Vec3f) public Matrixf RotateDeg(Vec3f degrees) Parameters degrees Vec3f Returns Matrixf RotateX(float) public Matrixf RotateX(float radX) Parameters radX float Returns Matrixf RotateXDeg(float) public Matrixf RotateXDeg(float degX) Parameters degX float Returns Matrixf RotateY(float) public Matrixf RotateY(float radY) Parameters radY float Returns Matrixf RotateYDeg(float) public Matrixf RotateYDeg(float degY) Parameters degY float Returns Matrixf RotateZ(float) public Matrixf RotateZ(float radZ) Parameters radZ float Returns Matrixf RotateZDeg(float) public Matrixf RotateZDeg(float degZ) Parameters degZ float Returns Matrixf Scale(float, float, float) public Matrixf Scale(float x, float y, float z) Parameters x float y float z float Returns Matrixf Set(double[]) public Matrixf Set(double[] values) Parameters values double[] Returns Matrixf Set(float[]) public Matrixf Set(float[] values) Parameters values float[] Returns Matrixf TransformVector(Vec4d) public Vec4d TransformVector(Vec4d vec) Parameters vec Vec4d Returns Vec4d TransformVector(Vec4f) public Vec4f TransformVector(Vec4f vec) Parameters vec Vec4f Returns Vec4f Translate(double, double, double) public Matrixf Translate(double x, double y, double z) Parameters x double y double z double Returns Matrixf Translate(float, float, float) public Matrixf Translate(float x, float y, float z) Parameters x float y float z float Returns Matrixf"
+ "keywords": "Class Matrixf Namespace Vintagestory.API.Client Assembly VintagestoryAPI.dll public class Matrixf Inheritance object Matrixf Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors Matrixf() public Matrixf() Matrixf(float[]) public Matrixf(float[] values) Parameters values float[] Fields Values public float[] Values Field Value float[] Properties ValuesAsDouble public double[] ValuesAsDouble { get; } Property Value double[] Methods Clone() public Matrixf Clone() Returns Matrixf Create() public static Matrixf Create() Returns Matrixf FollowPlayer() public Matrixf FollowPlayer() Returns Matrixf FollowPlayerXZ() public Matrixf FollowPlayerXZ() Returns Matrixf Identity() public Matrixf Identity() Returns Matrixf Invert() public Matrixf Invert() Returns Matrixf Mul(float[]) public Matrixf Mul(float[] matrix) Parameters matrix float[] Returns Matrixf Mul(Matrixf) public Matrixf Mul(Matrixf matrix) Parameters matrix Matrixf Returns Matrixf ReverseMul(float[]) public Matrixf ReverseMul(float[] matrix) Parameters matrix float[] Returns Matrixf Rotate(float, float, float) public Matrixf Rotate(float radX, float radY, float radZ) Parameters radX float radY float radZ float Returns Matrixf Rotate(Vec3f) public Matrixf Rotate(Vec3f radians) Parameters radians Vec3f Returns Matrixf RotateDeg(Vec3f) public Matrixf RotateDeg(Vec3f degrees) Parameters degrees Vec3f Returns Matrixf RotateX(float) public Matrixf RotateX(float radX) Parameters radX float Returns Matrixf RotateXDeg(float) public Matrixf RotateXDeg(float degX) Parameters degX float Returns Matrixf RotateY(float) public Matrixf RotateY(float radY) Parameters radY float Returns Matrixf RotateYDeg(float) public Matrixf RotateYDeg(float degY) Parameters degY float Returns Matrixf RotateZ(float) public Matrixf RotateZ(float radZ) Parameters radZ float Returns Matrixf RotateZDeg(float) public Matrixf RotateZDeg(float degZ) Parameters degZ float Returns Matrixf Scale(float, float, float) public Matrixf Scale(float x, float y, float z) Parameters x float y float z float Returns Matrixf Set(double[]) public Matrixf Set(double[] values) Parameters values double[] Returns Matrixf Set(float[]) public Matrixf Set(float[] values) Parameters values float[] Returns Matrixf TransformVector(Vec4d) public Vec4d TransformVector(Vec4d vec) Parameters vec Vec4d Returns Vec4d TransformVector(Vec4f) public Vec4f TransformVector(Vec4f vec) Parameters vec Vec4f Returns Vec4f Translate(double, double, double) public Matrixf Translate(double x, double y, double z) Parameters x double y double z double Returns Matrixf Translate(float, float, float) public Matrixf Translate(float x, float y, float z) Parameters x float y float z float Returns Matrixf"
},
"api/Vintagestory.API.Client.MeshData.MeshDataFilterDelegate.html": {
"href": "api/Vintagestory.API.Client.MeshData.MeshDataFilterDelegate.html",
@@ -1792,7 +1792,7 @@
"api/Vintagestory.API.Common.BlockSchematic.html": {
"href": "api/Vintagestory.API.Common.BlockSchematic.html",
"title": "Class BlockSchematic | VintageStory API",
- "keywords": "Class BlockSchematic Namespace Vintagestory.API.Common Assembly VintagestoryAPI.dll [JsonObject(MemberSerialization.OptIn)] public class BlockSchematic Inheritance object BlockSchematic Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors BlockSchematic() public BlockSchematic() Fields BlockCodes [JsonProperty] public Dictionary BlockCodes Field Value Dictionary BlockEntities [JsonProperty] public Dictionary BlockEntities Field Value Dictionary BlockEntitiesUnpacked public Dictionary BlockEntitiesUnpacked Field Value Dictionary BlockIds [JsonProperty] public List BlockIds Field Value List BlocksUnpacked public Dictionary BlocksUnpacked Field Value Dictionary DecorIds [JsonProperty] public List DecorIds Field Value List DecorIndices [JsonProperty] public List DecorIndices Field Value List DecorsUnpacked public Dictionary DecorsUnpacked Field Value Dictionary Entities [JsonProperty] public List Entities Field Value List EntitiesUnpacked public List EntitiesUnpacked Field Value List EntranceRotation [JsonProperty] public int EntranceRotation Field Value int FluidsLayerUnpacked public Dictionary FluidsLayerUnpacked Field Value Dictionary GameVersion [JsonProperty] public string GameVersion Field Value string Indices [JsonProperty] public List Indices Field Value List ItemCodes [JsonProperty] public Dictionary ItemCodes Field Value Dictionary OmitLiquids public bool OmitLiquids Field Value bool PackedOffset public FastVec3i PackedOffset Field Value FastVec3i PathwayOffsets Distance from the bottom left door block, so the bottom left door block is always at 0,0,0 public BlockPos[][] PathwayOffsets Field Value BlockPos[][] PathwaySides public BlockFacing[] PathwaySides Field Value BlockFacing[] PathwayStarts Distance positions from bottom left corner of the schematic. Only the first door block. public BlockPos[] PathwayStarts Field Value BlockPos[] ReplaceMode [JsonProperty] public EnumReplaceMode ReplaceMode Field Value EnumReplaceMode SizeX [JsonProperty] public int SizeX Field Value int SizeY [JsonProperty] public int SizeY Field Value int SizeZ [JsonProperty] public int SizeZ Field Value int UndergroundCheckPositions public BlockPos[] UndergroundCheckPositions Field Value BlockPos[] empty protected ushort empty Field Value ushort fillerBlock protected Block fillerBlock Field Value Block pathwayBlock protected Block pathwayBlock Field Value Block undergroundBlock protected Block undergroundBlock Field Value Block Properties BlockRemaps Set by the RemapperAssistant in OnFinalizeAssets public static Dictionary> BlockRemaps { get; set; } Property Value Dictionary> ItemRemaps Set by the RemapperAssistant in OnFinalizeAssets public static Dictionary> ItemRemaps { get; set; } Property Value Dictionary> Methods AddArea(IWorldAccessor, BlockPos, BlockPos) Adds an area to the schematic. public virtual void AddArea(IWorldAccessor world, BlockPos start, BlockPos end) Parameters world IWorldAccessor The world the blocks are in start BlockPos The start position of all the blocks. end BlockPos The end position of all the blocks. AdjustStartPos(BlockPos, EnumOrigin) Adjusts the starting position of the schemtic. public virtual BlockPos AdjustStartPos(BlockPos startpos, EnumOrigin origin) Parameters startpos BlockPos origin EnumOrigin Returns BlockPos ClonePacked() Makes a deep copy of the packed schematic. Unpacked data and loaded meta information is not cloned. public virtual BlockSchematic ClonePacked() Returns BlockSchematic DecodeBlockEntityData(string) Imports the tree data from a string. public virtual TreeAttribute DecodeBlockEntityData(string data) Parameters data string Returns TreeAttribute EncodeBlockEntityData(BlockEntity) Exports the block entity data to a string. public virtual string EncodeBlockEntityData(BlockEntity be) Parameters be BlockEntity Returns string GetJustPositions(BlockPos) Gets just the positions of the blocks. public virtual BlockPos[] GetJustPositions(BlockPos origin) Parameters origin BlockPos The origin point to start from Returns BlockPos[] An array containing the BlockPos of each block in the area. GetStartPos(BlockPos, EnumOrigin) Gets the starting position of the schematic. public virtual BlockPos GetStartPos(BlockPos pos, EnumOrigin origin) Parameters pos BlockPos origin EnumOrigin Returns BlockPos Init(IBlockAccessor) public virtual void Init(IBlockAccessor blockAccessor) Parameters blockAccessor IBlockAccessor InitMetaBlocks(IBlockAccessor) public void InitMetaBlocks(IBlockAccessor blockAccessor) Parameters blockAccessor IBlockAccessor LoadFromFile(string, ref string) Loads the schematic from a file. public static BlockSchematic LoadFromFile(string infilepath, ref string error) Parameters infilepath string error string Returns BlockSchematic LoadFromString(string, ref string) Loads a schematic from a string. public static BlockSchematic LoadFromString(string jsoncode, ref string error) Parameters jsoncode string error string Returns BlockSchematic LoadMetaInformationAndValidate(IBlockAccessor, IWorldAccessor, string) Loads the meta information for each block in the schematic. public void LoadMetaInformationAndValidate(IBlockAccessor blockAccessor, IWorldAccessor worldForResolve, string fileNameForLogging) Parameters blockAccessor IBlockAccessor worldForResolve IWorldAccessor fileNameForLogging string Pack(IWorldAccessor, BlockPos) public virtual bool Pack(IWorldAccessor world, BlockPos startPos) Parameters world IWorldAccessor startPos BlockPos Returns bool Place(IBlockAccessor, IWorldAccessor, BlockPos, bool) Will place all blocks using the configured replace mode. Note: If you use a revertable or bulk block accessor you will have to call PlaceBlockEntities() after the Commit() public virtual int Place(IBlockAccessor blockAccessor, IWorldAccessor worldForCollectibleResolve, BlockPos startPos, bool replaceMetaBlocks = true) Parameters blockAccessor IBlockAccessor worldForCollectibleResolve IWorldAccessor startPos BlockPos replaceMetaBlocks bool Returns int Place(IBlockAccessor, IWorldAccessor, BlockPos, EnumReplaceMode, bool) Will place all blocks using the supplied replace mode. Note: If you use a revertable or bulk block accessor you will have to call PlaceBlockEntities() after the Commit() public virtual int Place(IBlockAccessor blockAccessor, IWorldAccessor worldForCollectibleResolve, BlockPos startPos, EnumReplaceMode mode, bool replaceMetaBlocks = true) Parameters blockAccessor IBlockAccessor worldForCollectibleResolve IWorldAccessor startPos BlockPos mode EnumReplaceMode replaceMetaBlocks bool Returns int PlaceDecors(IBlockAccessor, BlockPos) public virtual void PlaceDecors(IBlockAccessor blockAccessor, BlockPos startPos) Parameters blockAccessor IBlockAccessor startPos BlockPos PlaceDecors(IBlockAccessor, BlockPos, Rectanglei) public virtual void PlaceDecors(IBlockAccessor blockAccessor, BlockPos startPos, Rectanglei rect) Parameters blockAccessor IBlockAccessor startPos BlockPos rect Rectanglei PlaceEntitiesAndBlockEntities(IBlockAccessor, IWorldAccessor, BlockPos, Dictionary, Dictionary, bool, Dictionary>, int, Dictionary, bool) Places all the entities and blocks in the schematic at the position. public void PlaceEntitiesAndBlockEntities(IBlockAccessor blockAccessor, IWorldAccessor worldForCollectibleResolve, BlockPos startPos, Dictionary blockCodes, Dictionary itemCodes, bool replaceBlockEntities = false, Dictionary> replaceBlocks = null, int centerrockblockid = 0, Dictionary layerBlockForBlockEntities = null, bool resolveImports = true) Parameters blockAccessor IBlockAccessor worldForCollectibleResolve IWorldAccessor startPos BlockPos blockCodes Dictionary itemCodes Dictionary replaceBlockEntities bool replaceBlocks Dictionary> centerrockblockid int layerBlockForBlockEntities Dictionary resolveImports bool Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn PlaceReplaceAll(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceAll(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int PlaceReplaceAllNoAir(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceAllNoAir(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int PlaceReplaceOnlyAir(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceOnlyAir(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int PlaceReplaceable(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceable(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int Save(string) Saves a schematic to a file. public virtual string Save(string outfilepath) Parameters outfilepath string Returns string StringEncodeTreeAttribute(ITreeAttribute) Exports the tree attribute data to a string. public virtual string StringEncodeTreeAttribute(ITreeAttribute tree) Parameters tree ITreeAttribute Returns string ToJson() public virtual string ToJson() Returns string TransformWhilePacked(IWorldAccessor, EnumOrigin, int, EnumAxis?) Attempts to transform each block as they are placed in directions different from the schematic. public virtual void TransformWhilePacked(IWorldAccessor worldForResolve, EnumOrigin aroundOrigin, int angle, EnumAxis? flipAxis = null) Parameters worldForResolve IWorldAccessor aroundOrigin EnumOrigin angle int flipAxis EnumAxis?"
+ "keywords": "Class BlockSchematic Namespace Vintagestory.API.Common Assembly VintagestoryAPI.dll [JsonObject(MemberSerialization.OptIn)] public class BlockSchematic Inheritance object BlockSchematic Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Constructors BlockSchematic() public BlockSchematic() Fields BlockCodes [JsonProperty] public Dictionary BlockCodes Field Value Dictionary BlockEntities [JsonProperty] public Dictionary BlockEntities Field Value Dictionary BlockEntitiesUnpacked public Dictionary BlockEntitiesUnpacked Field Value Dictionary BlockIds [JsonProperty] public List BlockIds Field Value List BlocksUnpacked public Dictionary BlocksUnpacked Field Value Dictionary DecorIds [JsonProperty] public List DecorIds Field Value List DecorIndices [JsonProperty] public List DecorIndices Field Value List DecorsUnpacked public Dictionary DecorsUnpacked Field Value Dictionary Entities [JsonProperty] public List Entities Field Value List EntitiesUnpacked public List EntitiesUnpacked Field Value List EntranceRotation [JsonProperty] public int EntranceRotation Field Value int FluidsLayerUnpacked public Dictionary FluidsLayerUnpacked Field Value Dictionary GameVersion [JsonProperty] public string GameVersion Field Value string Indices [JsonProperty] public List Indices Field Value List ItemCodes [JsonProperty] public Dictionary ItemCodes Field Value Dictionary OmitLiquids public bool OmitLiquids Field Value bool PackedOffset public FastVec3i PackedOffset Field Value FastVec3i PathwayOffsets Distance from the bottom left door block, so the bottom left door block is always at 0,0,0 public BlockPos[][] PathwayOffsets Field Value BlockPos[][] PathwaySides public BlockFacing[] PathwaySides Field Value BlockFacing[] PathwayStarts Distance positions from bottom left corner of the schematic. Only the first door block. public BlockPos[] PathwayStarts Field Value BlockPos[] ReplaceMode [JsonProperty] public EnumReplaceMode ReplaceMode Field Value EnumReplaceMode SizeX [JsonProperty] public int SizeX Field Value int SizeY [JsonProperty] public int SizeY Field Value int SizeZ [JsonProperty] public int SizeZ Field Value int UndergroundCheckPositions public BlockPos[] UndergroundCheckPositions Field Value BlockPos[] empty protected ushort empty Field Value ushort fillerBlock protected Block fillerBlock Field Value Block pathwayBlock protected Block pathwayBlock Field Value Block undergroundBlock protected Block undergroundBlock Field Value Block Properties BlockRemaps Set by the RemapperAssistant in OnFinalizeAssets Heads up!: This is unordered, it will iterate through the different game versions' remaps not necessarily in the order they originally appear in remaps.json config. If any block remaps over the years have duplicate original block names, behavior for those ones may be unpredictable public static Dictionary> BlockRemaps { get; set; } Property Value Dictionary> ItemRemaps Set by the RemapperAssistant in OnFinalizeAssets public static Dictionary> ItemRemaps { get; set; } Property Value Dictionary> Methods AddArea(IWorldAccessor, BlockPos, BlockPos) Adds an area to the schematic. public virtual void AddArea(IWorldAccessor world, BlockPos start, BlockPos end) Parameters world IWorldAccessor The world the blocks are in start BlockPos The start position of all the blocks. end BlockPos The end position of all the blocks. AdjustStartPos(BlockPos, EnumOrigin) Adjusts the starting position of the schemtic. public virtual BlockPos AdjustStartPos(BlockPos startpos, EnumOrigin origin) Parameters startpos BlockPos origin EnumOrigin Returns BlockPos ClonePacked() Makes a deep copy of the packed schematic. Unpacked data and loaded meta information is not cloned. public virtual BlockSchematic ClonePacked() Returns BlockSchematic DecodeBlockEntityData(string) Imports the tree data from a string. public virtual TreeAttribute DecodeBlockEntityData(string data) Parameters data string Returns TreeAttribute EncodeBlockEntityData(BlockEntity) Exports the block entity data to a string. public virtual string EncodeBlockEntityData(BlockEntity be) Parameters be BlockEntity Returns string GetJustPositions(BlockPos) Gets just the positions of the blocks. public virtual BlockPos[] GetJustPositions(BlockPos origin) Parameters origin BlockPos The origin point to start from Returns BlockPos[] An array containing the BlockPos of each block in the area. GetStartPos(BlockPos, EnumOrigin) Gets the starting position of the schematic. public virtual BlockPos GetStartPos(BlockPos pos, EnumOrigin origin) Parameters pos BlockPos origin EnumOrigin Returns BlockPos Init(IBlockAccessor) public virtual void Init(IBlockAccessor blockAccessor) Parameters blockAccessor IBlockAccessor InitMetaBlocks(IBlockAccessor) public void InitMetaBlocks(IBlockAccessor blockAccessor) Parameters blockAccessor IBlockAccessor LoadFromFile(string, ref string) Loads the schematic from a file. public static BlockSchematic LoadFromFile(string infilepath, ref string error) Parameters infilepath string error string Returns BlockSchematic LoadFromString(string, ref string) Loads a schematic from a string. public static BlockSchematic LoadFromString(string jsoncode, ref string error) Parameters jsoncode string error string Returns BlockSchematic LoadMetaInformationAndValidate(IBlockAccessor, IWorldAccessor, string) Loads the meta information for each block in the schematic. public void LoadMetaInformationAndValidate(IBlockAccessor blockAccessor, IWorldAccessor worldForResolve, string fileNameForLogging) Parameters blockAccessor IBlockAccessor worldForResolve IWorldAccessor fileNameForLogging string Pack(IWorldAccessor, BlockPos) public virtual bool Pack(IWorldAccessor world, BlockPos startPos) Parameters world IWorldAccessor startPos BlockPos Returns bool Place(IBlockAccessor, IWorldAccessor, BlockPos, bool) Will place all blocks using the configured replace mode. Note: If you use a revertable or bulk block accessor you will have to call PlaceBlockEntities() after the Commit() public virtual int Place(IBlockAccessor blockAccessor, IWorldAccessor worldForCollectibleResolve, BlockPos startPos, bool replaceMetaBlocks = true) Parameters blockAccessor IBlockAccessor worldForCollectibleResolve IWorldAccessor startPos BlockPos replaceMetaBlocks bool Returns int Place(IBlockAccessor, IWorldAccessor, BlockPos, EnumReplaceMode, bool) Will place all blocks using the supplied replace mode. Note: If you use a revertable or bulk block accessor you will have to call PlaceBlockEntities() after the Commit() public virtual int Place(IBlockAccessor blockAccessor, IWorldAccessor worldForCollectibleResolve, BlockPos startPos, EnumReplaceMode mode, bool replaceMetaBlocks = true) Parameters blockAccessor IBlockAccessor worldForCollectibleResolve IWorldAccessor startPos BlockPos mode EnumReplaceMode replaceMetaBlocks bool Returns int PlaceDecors(IBlockAccessor, BlockPos) public virtual void PlaceDecors(IBlockAccessor blockAccessor, BlockPos startPos) Parameters blockAccessor IBlockAccessor startPos BlockPos PlaceDecors(IBlockAccessor, BlockPos, Rectanglei) public virtual void PlaceDecors(IBlockAccessor blockAccessor, BlockPos startPos, Rectanglei rect) Parameters blockAccessor IBlockAccessor startPos BlockPos rect Rectanglei PlaceEntitiesAndBlockEntities(IBlockAccessor, IWorldAccessor, BlockPos, Dictionary, Dictionary, bool, Dictionary>, int, Dictionary, bool) Places all the entities and blocks in the schematic at the position. public void PlaceEntitiesAndBlockEntities(IBlockAccessor blockAccessor, IWorldAccessor worldForCollectibleResolve, BlockPos startPos, Dictionary blockCodes, Dictionary itemCodes, bool replaceBlockEntities = false, Dictionary> replaceBlocks = null, int centerrockblockid = 0, Dictionary layerBlockForBlockEntities = null, bool resolveImports = true) Parameters blockAccessor IBlockAccessor worldForCollectibleResolve IWorldAccessor startPos BlockPos blockCodes Dictionary itemCodes Dictionary replaceBlockEntities bool replaceBlocks Dictionary> centerrockblockid int layerBlockForBlockEntities Dictionary resolveImports bool Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn PlaceReplaceAll(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceAll(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int PlaceReplaceAllNoAir(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceAllNoAir(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int PlaceReplaceOnlyAir(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceOnlyAir(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int PlaceReplaceable(IBlockAccessor, BlockPos, Block, bool) protected virtual int PlaceReplaceable(IBlockAccessor blockAccessor, BlockPos pos, Block newBlock, bool replaceMeta) Parameters blockAccessor IBlockAccessor pos BlockPos newBlock Block replaceMeta bool Returns int Save(string) Saves a schematic to a file. public virtual string Save(string outfilepath) Parameters outfilepath string Returns string StringEncodeTreeAttribute(ITreeAttribute) Exports the tree attribute data to a string. public virtual string StringEncodeTreeAttribute(ITreeAttribute tree) Parameters tree ITreeAttribute Returns string ToJson() public virtual string ToJson() Returns string TransformWhilePacked(IWorldAccessor, EnumOrigin, int, EnumAxis?) Attempts to transform each block as they are placed in directions different from the schematic. public virtual void TransformWhilePacked(IWorldAccessor worldForResolve, EnumOrigin aroundOrigin, int angle, EnumAxis? flipAxis = null) Parameters worldForResolve IWorldAccessor aroundOrigin EnumOrigin angle int flipAxis EnumAxis?"
},
"api/Vintagestory.API.Common.BlockSelection.html": {
"href": "api/Vintagestory.API.Common.BlockSelection.html",
@@ -3827,7 +3827,7 @@
"api/Vintagestory.API.Config.GameVersion.html": {
"href": "api/Vintagestory.API.Config.GameVersion.html",
"title": "Class GameVersion | VintageStory API",
- "keywords": "Class GameVersion Namespace Vintagestory.API.Config Assembly VintagestoryAPI.dll The games current version public static class GameVersion Inheritance object GameVersion Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields APIVersion Version of the Mod API public const string APIVersion = \"1.19.0\" Field Value string AssemblyVersion Assembly Info Version number in the format: major.minor.revision public const string AssemblyVersion = \"1.0.0.0\" Field Value string BlockItemMappingVersion \"Version\" of the block and item mapping. This number gets increased by 1 when remappings are needed public static int BlockItemMappingVersion Field Value int Branch Whether this is a stable or unstable version public const EnumGameBranch Branch = Unstable Field Value EnumGameBranch ChunkdataVersion Version of the chunkdata compression for individual WorldChunks (0 is Deflate; 1 is ZSTD and palettised) Also affects compression of network packets sent public const int ChunkdataVersion = 2 Field Value int CopyRight Copyright notice public const string CopyRight = \"Copyright © 2016-2024 Anego Studios\" Field Value string DatabaseVersion Version of the savegame database public static int DatabaseVersion Field Value int LongGameVersion Version number in the format: major.minor.revision [release title] public static string LongGameVersion Field Value string NetworkVersion Version of the Network Protocol public const string NetworkVersion = \"1.19.7\" Field Value string OverallVersion Assembly Info Version number in the format: major.minor.revision public const string OverallVersion = \"1.19.4\" Field Value string ShortGameVersion Version number in the format: major.minor.revision[appendix] public const string ShortGameVersion = \"1.19.4-rc.3\" Field Value string WorldGenVersion Version of the world generator - a change in version will insert a smoothed chunk between old and new version public const int WorldGenVersion = 2 Field Value int Properties ReleaseType public static EnumReleaseType ReleaseType { get; } Property Value EnumReleaseType Methods EnsureEqualVersionOrKillExecutable(ICoreAPI, string, string, string) public static void EnsureEqualVersionOrKillExecutable(ICoreAPI api, string version, string reference, string modName) Parameters api ICoreAPI version string reference string modName string GetReleaseType(string) public static EnumReleaseType GetReleaseType(string version) Parameters version string Returns EnumReleaseType IsAtLeastVersion(string) Returns true if supplied version is the same or higher as the current version public static bool IsAtLeastVersion(string version) Parameters version string Returns bool IsAtLeastVersion(string, string) Returns true if supplied version is the same or higher as the reference version public static bool IsAtLeastVersion(string version, string reference) Parameters version string reference string Returns bool IsCompatibleApiVersion(string) Returns true if given version has the same major and minor version. Ignores revision. public static bool IsCompatibleApiVersion(string version) Parameters version string Returns bool IsCompatibleNetworkVersion(string) Returns true if given version has the same major and minor version. Ignores revision. public static bool IsCompatibleNetworkVersion(string version) Parameters version string Returns bool IsLowerVersionThan(string, string) public static bool IsLowerVersionThan(string version, string reference) Parameters version string reference string Returns bool IsNewerVersionThan(string, string) Returns true if supplied version is the higher as the reference version public static bool IsNewerVersionThan(string version, string reference) Parameters version string reference string Returns bool SplitVersionString(string) public static int[] SplitVersionString(string version) Parameters version string Returns int[]"
+ "keywords": "Class GameVersion Namespace Vintagestory.API.Config Assembly VintagestoryAPI.dll The games current version public static class GameVersion Inheritance object GameVersion Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields APIVersion Version of the Mod API public const string APIVersion = \"1.19.0\" Field Value string AssemblyVersion Assembly Info Version number in the format: major.minor.revision public const string AssemblyVersion = \"1.0.0.0\" Field Value string BlockItemMappingVersion \"Version\" of the block and item mapping. This number gets increased by 1 when remappings are needed public static int BlockItemMappingVersion Field Value int Branch Whether this is a stable or unstable version public const EnumGameBranch Branch = Stable Field Value EnumGameBranch ChunkdataVersion Version of the chunkdata compression for individual WorldChunks (0 is Deflate; 1 is ZSTD and palettised) Also affects compression of network packets sent public const int ChunkdataVersion = 2 Field Value int CopyRight Copyright notice public const string CopyRight = \"Copyright © 2016-2024 Anego Studios\" Field Value string DatabaseVersion Version of the savegame database public static int DatabaseVersion Field Value int LongGameVersion Version number in the format: major.minor.revision [release title] public static string LongGameVersion Field Value string NetworkVersion Version of the Network Protocol public const string NetworkVersion = \"1.19.7\" Field Value string OverallVersion Assembly Info Version number in the format: major.minor.revision public const string OverallVersion = \"1.19.4\" Field Value string ShortGameVersion Version number in the format: major.minor.revision[appendix] public const string ShortGameVersion = \"1.19.4\" Field Value string WorldGenVersion Version of the world generator - a change in version will insert a smoothed chunk between old and new version public const int WorldGenVersion = 2 Field Value int Properties ReleaseType public static EnumReleaseType ReleaseType { get; } Property Value EnumReleaseType Methods EnsureEqualVersionOrKillExecutable(ICoreAPI, string, string, string) public static void EnsureEqualVersionOrKillExecutable(ICoreAPI api, string version, string reference, string modName) Parameters api ICoreAPI version string reference string modName string GetReleaseType(string) public static EnumReleaseType GetReleaseType(string version) Parameters version string Returns EnumReleaseType IsAtLeastVersion(string) Returns true if supplied version is the same or higher as the current version public static bool IsAtLeastVersion(string version) Parameters version string Returns bool IsAtLeastVersion(string, string) Returns true if supplied version is the same or higher as the reference version public static bool IsAtLeastVersion(string version, string reference) Parameters version string reference string Returns bool IsCompatibleApiVersion(string) Returns true if given version has the same major and minor version. Ignores revision. public static bool IsCompatibleApiVersion(string version) Parameters version string Returns bool IsCompatibleNetworkVersion(string) Returns true if given version has the same major and minor version. Ignores revision. public static bool IsCompatibleNetworkVersion(string version) Parameters version string Returns bool IsLowerVersionThan(string, string) public static bool IsLowerVersionThan(string version, string reference) Parameters version string reference string Returns bool IsNewerVersionThan(string, string) Returns true if supplied version is the higher as the reference version public static bool IsNewerVersionThan(string version, string reference) Parameters version string reference string Returns bool SplitVersionString(string) public static int[] SplitVersionString(string version) Parameters version string Returns int[]"
},
"api/Vintagestory.API.Config.GlobalConstants.html": {
"href": "api/Vintagestory.API.Config.GlobalConstants.html",
diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml
index a17776ab..c6546dd4 100644
--- a/docs/xrefmap.yml
+++ b/docs/xrefmap.yml
@@ -33315,6 +33315,15 @@ references:
fullName.vb: Vintagestory.API.Client.Matrixf.New()
nameWithType: Matrixf.Matrixf()
nameWithType.vb: Matrixf.New()
+- uid: Vintagestory.API.Client.Matrixf.#ctor(System.Single[])
+ name: Matrixf(float[])
+ href: api/Vintagestory.API.Client.Matrixf.html#Vintagestory_API_Client_Matrixf__ctor_System_Single___
+ commentId: M:Vintagestory.API.Client.Matrixf.#ctor(System.Single[])
+ name.vb: New(Single())
+ fullName: Vintagestory.API.Client.Matrixf.Matrixf(float[])
+ fullName.vb: Vintagestory.API.Client.Matrixf.New(Single())
+ nameWithType: Matrixf.Matrixf(float[])
+ nameWithType.vb: Matrixf.New(Single())
- uid: Vintagestory.API.Client.Matrixf.#ctor*
name: Matrixf
href: api/Vintagestory.API.Client.Matrixf.html#Vintagestory_API_Client_Matrixf__ctor_
@@ -33412,6 +33421,12 @@ references:
fullName.vb: Vintagestory.API.Client.Matrixf.Mul(Single())
nameWithType: Matrixf.Mul(float[])
nameWithType.vb: Matrixf.Mul(Single())
+- uid: Vintagestory.API.Client.Matrixf.Mul(Vintagestory.API.Client.Matrixf)
+ name: Mul(Matrixf)
+ href: api/Vintagestory.API.Client.Matrixf.html#Vintagestory_API_Client_Matrixf_Mul_Vintagestory_API_Client_Matrixf_
+ commentId: M:Vintagestory.API.Client.Matrixf.Mul(Vintagestory.API.Client.Matrixf)
+ fullName: Vintagestory.API.Client.Matrixf.Mul(Vintagestory.API.Client.Matrixf)
+ nameWithType: Matrixf.Mul(Matrixf)
- uid: Vintagestory.API.Client.Matrixf.Mul*
name: Mul
href: api/Vintagestory.API.Client.Matrixf.html#Vintagestory_API_Client_Matrixf_Mul_