VintagestoryAPI This is the system that manages the worlds ambient settings, such as fog color/density and clouds. The ambient manager basically blends ambientmodifiers on top of each other to generate the final ambient values. Blending is in order how the modifiers are held in CurrentModifiers in the likes of float weight = modifier.FogMin.Weight; BlendedFogMin = w * modifier.FogMin.Value + (1 - w) * BlendedFogMin; The base value or background ambient to overlay everything onto The list of modifiers that result in the blended values The blended fog color, calculated every frame from the list of modifiers The blended ambient color, calculated every frame from the list of modifiers The blended fog density, calculated every frame from the list of modifiers The blended flat fog density, calculated every frame from the list of modifiers The blended flat fog y-offset, calculated every frame from the list of modifiers BlendedFlatFogYPos + SeaLevel - MainCamera.TargetPosition.Y The blended fog min, calculated every frame from the list of modifiers The blended cloud brightness, calculated every frame from the list of modifiers The blended cloud density, calculated every frame from the list of modifiers The update loop for this manager. Runs every frame. the Delta or change in Time Supplies you with your very own and personal network channel with which you can send packets to the server. Use the same channelName on the client and server to have them link up. Unique channel identifier Supplies you with your very own and personal network channel with which you can send packets to the server. Use the same channelName on the client and server to have them link up. Do not send larger messages then 508 bytes since some clients may be behind NAT/firwalls that may drop your packets if they get fragmented Unique channel identifier Returns a previously registered channeled, null otherwise Returns a previously registered channeled, null otherwise Constants used for GetBlock or GetBlockId calls throughout the engine, to guide whether the block should be read from the solid blocks layer, the fluids layer, or perhaps both.
The game engine supports different block layers in 1.17+. Currently there is a solid blocks layer (e.g. terrain, loose stones, plants, reeds) and a fluid layer (e.g. still water, flowing water, lava, lake ice). Both layers can contain a block at the same position.
Use the .Default value for getting blocks in the general case, use the .Solid/.Fluid value to read from the solid blocks or fluid layer specifically GetBlock:
Returns the contents of the solid blocks layer. If the solid blocks layer is completely empty, returns the value from the fluid layer instead. Keep in mind, the fluid layer might contain ice!
If this returns air (block id 0) then it really is an air block: there is nothing in either the solid blocks layer or the fluid layer SetBlock:
Sets supplied block id. If that blocks property ForFluidsLayer is true, it will be placed in the fluids layer instead and the solid block layer will be cleared. Returns a block from the solid blocks layer only.
A return value of air (block id 0) signifies no solid block is present but there may still be a fluid block, for example still water Returns a block from the solid blocks layer only. Same as Returns a block from the fluid layer only, which might contain ice.
A return value of air (block id 0) signifies no fluid is present at this position Returns the contents of the fluid layer, unless it is empty in which case returns the solid blocks layer - useful for generating the RainHeightMap for example Returns the most solid block, in the following order:
1. Ice in the fluid layer
2. Whichever block is in the solid blocks layer
3. Air (block id 0) if neither is present - note this access may therefore return 0 even if liquid water or lava is present in the fluid layer.

Useful for block collision checks, side solid checks (can a block attach here?) and similar physics The arguments from a client or sever command Creates a new instance of the CmdArgs util with no arguments Creates a new instance of the CmdArgs util Creates a new instance of the CmdArgs util Returns the n-th arugment Amount of arguments passed Returns all remaining arguments as single merged string, concatenated with spaces Returns the first char of the first argument Remove the first character from the first argument and returns it Removes the first argument and returns it, scans until it encounters a white space Removes the first argument and returns it Adds an arg to the beginning Adds an arg to the end Tries to retrieve arg at given index as enum value or default if not enough arguments or not part of the enum Tries to retrieve arg at given index as int, or null if not enough arguments or not an integer Tries to parse a string to an integer, returns 0 if it fails
Enhancements over system int.TryParse(): (1) the thousands separator (comma) is ignored (2) hex numbers are possible with 0x prefix (3) uint values over int.MaxValue are possible (may convert to a negative int, but that can be converted back to the original uint), more generally any valid long value is permitted
All three enhancements are useful if we ever need, in a command, to set - for example - a color value (32 bits) from hex or unsigned decimal Tries to retrieve arg at given index as long, or null if not enough arguments or not a long Tries to retrieve arg at given index as boolean, or null if not enough arguments or not an integer
'true', 'yes' and '1' will all be interpreted as true. Parameter trueAlias (with default value 'on') allows one additional word to be used to signify true. Anything else will return false. Tries to retrieve arg at given index as int, or null if not enough arguments or not an integer Tries to retrieve arg at given index as float, or null if not enough arguments or not a float Tries to retrieve 3 int coordinates from the next 3 arguments Retrieves a player position with following syntax: [coord] [coord] [coord] whereas [coord] may be ~[decimal] or =[decimal] or [decimal] ~ denotes a position relative to the player = denotes an absolute position no prefix denots a position relative to the map middle Retrieves a player position with following syntax: [coord] [coord] [coord] whereas [coord] may be ~[decimal] or =[decimal] or [decimal] ~ denotes a position relative to the player = denotes an absolute position no prefix denots a position relative to the map middle Defaults to caller entity A currently online player All selected players All selected players Parses IPlayerRole, only works on Serverside since it needs the Serverconfig Parses IPlayerRole, only works on Serverside since it needs the Serverconfig Parses a string which is either a color name or a hex value as a Parses a string which is either a color name or a hex value as a All remaining arguments together All remaining arguments together Defaults to caller position Currently only supports time spans (i.e. now + time) Name of this command plus parent command names Name of this command Get the description of this command Get the detailed description of this command Get the examples of this command True if either name or privilege has not been set Aliases for this command or subcommand RootAliases for this command or subcommand Get the prefix of this command Retrieve subcommand If return value is error, command cannot be executed Sets the command name Registers alternative names for this command Registers an alternative name for this command, always at the root level, i.e. /name Set command description Set additional detailed command description, for command-specific help Define one ore more examples on how this command can be executed Define command arguments, you'd usually want to use one of the parsers supplied from from capi.ChatCommands.Parsers Define the required privilege to run this command / subcommand This command can only be run if the caller is a player Define/Modify a subcommnad. Returns a new subcommand instance. Define/Modify multiple subcommands. Returns a new subcommand instance. Leave current subcommand. Returns parent command instance. Define method to be called when the command is executed Manually execute this command Confirm whether the specified caller has the required privilege for this command Optional validation step that ensures that all the command and all its subcommands has a name, handler, privilege and description defined Get a string showing how to call this command or subcommand Add text listing the parameters Add text explaining the form and interpretation of some of the more complex parameter types ChatCommand Abbreviations Alias of WithDescription() Alias for BeginSubCommand Alias for BeginSubCommands Alias for EndSubCommand Command cannot execute at this point, likely doing an async call. Prints no output. The command encountered an issue Command status is unknown because this is a legacy command using the old method of registering commands Will be displayed with a Lang.Get() Return -1 to ignore arg count checking Parse the args. Only needs to be called when returning Deferred as parseresult Used by the async system Executes a parsed command Name of the command without arguments, without prefix Called when the command finished executing Executes a raw command Full command line, e.g. /entity spawn chicken-hen 1 Called when the command finished executing Get all commands ordered by name ASC Get all commands from ordered by name ASC A base class for all chat commands. the command calling name. The syntax of the command. The description of the command. The required privilage for the command to be ran. The call handler for the command. The player calling the command. The groupID of the player. The arguments of the command. gets the description of the command. Gets the syntax of the command. Gets the help message of the command. A handler for creating server commands. Whether or not the player has the privilage to run the command. A handle for creating client commands. Return false to stop walking the inventory Return true if the action/event should be "consumed" (e.g. mark a mouse click as handled) Return true if the action/event should be "consumed" (e.g. mark a mouse click as handled) Return true if the action/event was successfull Returns true if the action/event was successfull. The additional type to pass in. The arguments for the event. Returns true if the action/event was successfull. The additional type to pass in. The additional type to pass in. Returns true if the action/event was successfull. The additional type to pass in. The additional type to pass in. The additional type to pass in. Returns true if the action/event was successfull. The additional type to pass in. The additional type to pass in. The additional type to pass in. Return true if the action/event should be "consumed" (e.g. mark a mouse click as handled) When the player wrote a chat message. Set consumed.value to true to prevent further processing of this chat message The player that submitted the chat message The chat group id from where the message was sent from The chat message If set, the even is considered consumed, i.e. should no longer be handled further by the game engine The resulting string. When the player died, this delegate will fire. The player that died. The source of the damage. The delegate for a dialogue click. The player that clicked the dialogue. The internal name of the Widget. Test if a player has the privilege to modify a block at given block selection Needs to be set when false is returned. Is used to display the reason why the placement was denied. Either it needs to be the name of a player/npc who owns this block, or it needs to be prefixed with custommessage- for a custom error message, e.g. "custommessage-nobuildprivilege": "No build privilege" False to deny placement A server/client side used by for the Vintage Story app. For server side things only. For client side things only. For server and client side things. Am I the server? Am I the client? Am I a universal? Am I this side? Access ok or was called client side Players in spectator mode may not place blocks Player tries to place/break blocks but is in guest mode Dead players may not place blocks This player was not granted the block build or use privilege Player does not have the build/use blocks every privilege and the position is claimed by another player A mod denied use/placement Contains either liquid layer of solid layer block Contains liquid layer of block If this value is negative, it indicates no change to the block (neither air block nor anything else) because only the fluid is being updated If this value is negative, it indicates no change to the fluids layer block (neither air block nor anything else) because only the solid block is being updated If set this entity was spawned or Moved (position needs to be set too) If set this entity needs to be spawned If set the entity was moved A climate condition at a given position Between -20 and +40 degrees If you read the now values, you can still get the world gen rain fall from this value. Between 0..1 If you read the now values, you can still get the world gen temp from this value Nomalized value between 0..1. Static value determined on world generation Nomalized value between 0..1. When loading the now values, this is set to the current precipitation value, otherwise to "yearly averages" or the values generated during worldgen Nomalized value between 0..1 Nomalized value between 0..1 Nomalized value between 0..1 Used in blockAccessor.GetLightLevel() to determine what kind of light level you want Will get you just the block light Will get you just the sun light unaffected by the day/night cycle Will get you max(sunlight, onlyblocklight) Will get you max(sunlight * sunbrightness, blocklight) Will get you sunlight * sunbrightness Will get you sunbrightness True if the most recent GetBlock or SetBlock had a laoded chunk Provides read/write access to the blocks of a world Width, Length and Height of a chunk Width and Length of a region in blocks X Size of the world in blocks Y Size of the world in blocks Z Size of the world in blocks Whether to update the snow accum map on a SetBlock() Size of the world in blocks Retrieve chunk at given chunk position (= divide block position by chunk size)
For dimension awareness, chunkY would need to be based on BlockPos.InternalY / chunksize or else explicitly include the dimensionId multiplied by GlobalConstants.DimensionSizeInChunks Retrieve chunk at given chunk position, returns null if chunk is not loaded Retrieves a map region at given region position, returns null if region is not loaded Retrieve chunk at given block position, returns null if chunk is not loaded Get the block id of the block at the given world coordinate Get the block type of the block at the given world coordinate, dimension aware. Will never return null. For air blocks or invalid coordinates you'll get a block instance with block code "air" and id 0 Same as with BlockLayersAccess.Default as layer Direct raw coordinate access to blocks. PLEASE NOTE: The caller has to ensure dimension awareness (i.e. pos.InternalY when using BlockPos)
Gets the block type of the block at the given world coordinate. x coordinate y coordinate z coordinate The block layer to retrieve from. See also Never null. For unpopulated locations or invalid coordinates you'll get a block instance with block code "air" and id 0 Get block type at given world coordinate, dimension aware. Will never return null. For airblocks or invalid coordinates you'll get a block instance with block code "air" and id 0
Reads the block from the specified layer(s), see BlockLayersAccess documentation for details. blocks layer e.g. solid, fluid etc. Same as with BlockLayersAccess.MostSolid as layer Retrieve chunk at given block position, returns null if chunk is not loaded Get the block id of the block at the given world coordinate Get the block type of the block at the given world coordinate. For invalid or unloaded coordinates this method returns null. x coordinate y coordinate z coordinate Block layer ID of the block at the given position Get the block type of the block at the given world coordinate. Will never return null. For airblocks or invalid coordinates you'll get a block instance with block code "air" and id 0
Reads the block from the specified layer(s), see documentation for details.
If this must be used even though it's deprecated, please consider using .GetBlockRaw() instead where calling code is explicitly dimension-aware x coordinate y coordinate z coordinate blocks layer e.g. solid, fluid etc. ID of the block at the given position Get the block type of the block at the given world coordinate. Will never return null. For air blocks or invalid coordinates you'll get a block instance with block code "air" and id 0 Same as with BlockLayersAccess.Default as layer Same as with BlockLayersAccess.MostSolid as layer A method to iterate over blocks in an area. Less overhead than when calling GetBlock(pos) many times. If there is liquids in the liquid layer, the onBlock method will be called twice. Currently used for more efficient collision testing.
Currently NOT dimensionally aware The method in which you want to check for the block, whatever it may be. If true, the blocks will be ordered by the distance to the center position A method to search for a given block in an area
Currently NOT dimensionally aware Return false to stop the search Called when a missing/unloaded chunk was encountered A method to search for a given fluid block in an area
Currently NOT dimensionally aware Return false to stop the search Called when a missing/unloaded chunk was encountered Calls given handler if it encounters one or more generated structure at given position (read from mapregions, assuming a max structure size of 256x256x256) Calls given handler if it encounters one or more generated structure that intersect any position inside minpos->maxpos (read from mapregions, assuming a max structure size of 256x256x256) Set a block at the given position. Use blockid 0 to clear that position from any blocks. Marks the chunk dirty so that it gets saved to disk during shutdown or next autosave. If called with a fluid block, the fluid will automatically get set in the fluid layer, and the solid layer will be emptied. Sets a block to given layer. Can only use "BlockLayersAccess.Solid" or "BlockLayersAccess.Liquid". Use id 0 to clear a block from given position. Marks the chunk dirty so that it gets saved to disk during shutdown or next autosave. Set a block at the given position. Use blockid 0 to clear that position from any blocks. Marks the chunk dirty so that it gets saved to disk during shutdown or next autosave. If called with a fluid block, the fluid will automatically get set in the fluid layer, and the solid layer will be emptied. If set then it will be passed onto the block.OnBlockPlaced method Set a block at the given position without calling OnBlockRemoved or OnBlockPlaced, which prevents any block entity from being removed or placed. Marks the chunk dirty so that it gets saved to disk during shutdown or next autosave. Should only be used if you want to prevent any block entity deletion at this position.
This also, for example, does not change a block's reinforcement level, useful for openable blocks such as doors, gates etc Removes the block at given position and calls Block.GetDrops(), Block.OnBreakBlock() and Block.OnNeighbourBlockChange() for all neighbours. Drops the items that are return from Block.GetDrops() Client Side: Will render the block breaking decal on that block. If the remaining block resistance reaches 0, will call break block Server Side: Broadcasts a package to all nearby clients to update the block damage of this block for rendering the decal (note: there is currently no server side list of current block damages, these are client side only at the moemnt) Get the Block object of a certain block ID. Returns null when not found. The block ID to search for BlockType object Get the Block object of for given block code. Returns null when not found. Spawn block entity at this position. Does not place its corresponding block, you have to do this yourself. Adds pre-initialized block entity to the world. Does not call CreateBehaviors/Initialize/OnBlockPlaced on the block entity. This is a very low level method for block entity spawning, normally you'd want to use Permanently removes any block entity at this postion. Does not remove its corresponding block, you have to do this yourself. Marks the chunk dirty so that it gets saved to disk during shutdown or next autosave. Retrieve the block entity at given position. Returns null if there is no block entity at this position Retrieve the block entity at given position. Returns null if there is no block entity at this position Checks if the position is inside the maps boundaries Checks if the position is inside the maps boundaries Checks if this position can be traversed by a normal player (returns false for outside map or not yet loaded chunks) Checks if this position can be traversed by a normal player (returns false for outside map or not yet loaded chunks) Dimension-aware version Checks if this position can be traversed by a normal player (returns false for outside map or not yet loaded chunks) Calling this method has no effect in normal block acessors except for: - Bulk update block accessor: Sets all blocks, relight all affected one chunks in one go and send blockupdates to clients in a packed format. - World gen block accessor: To Recalculate the heightmap in of all updated blocks in one go - Revertable block accessor: Same as bulk update block accessor plus stores a new history state. List of changed blocks For the bulk update block accessor reverts all the SetBlocks currently called since the last Commit() Server side call: Resends the block entity data (if present) to all clients. Triggers a block changed event on the client once received , but will not redraw the chunk. Marks also the chunk dirty so that it gets saved to disk during shutdown or next autosave.
Client side call: No effect Triggers the method OnNeighbourBlockChange() to all neighbour blocks at given position Server side: Sends that block to the client (via bulk packet). Through that packet the client will do a SetBlock on that position (which triggers a redraw if oldblockid != newblockid).
Client side: Triggers a block changed event and redraws the chunk Server side: Does not send the update to this player, Client Side: No effect Server side: Triggers a OnNeighbourBlockChange on that position and sends that block to the client (via bulk packet), through that packet the client will do a SetBlock on that position (which triggers a redraw if oldblockid != newblockid).
Client side: Triggers a block changed event and redraws the chunk. Deletes and re-create block entities Server Side: Same as MarkBlockDirty()
Client Side: Same as MarkBlockDirty(), but also calls supplied delegate after the chunk has been re-retesselated. This can be used i.e. for block entities to dynamically switch between static models and dynamic models at exactly the right timing Returns the light level (0..32) at given position. If the chunk at that position is not loaded this method will return the default sunlight value Returns the light level (0..32) at given position. If the chunk at that position is not loaded this method will return the default sunlight value
Note this is not currently dimensionally aware Returns the light values at given position. XYZ component = block light rgb, W component = sun light brightness
Note this is not currently dimensionally aware Returns the light values at given position. XYZ component = block light rgb, W component = sun light brightness Returns the light values at given position. bit 0-23: block rgb light, bit 24-31: sun light brightness Returns the topmost solid surface position at given x/z coordinate as it was during world generation. This map is not updated after placing/removing blocks
Note this is meaningless in dimensions other than the normal world Returns the topmost non-rain-permeable position at given x/z coordinate. This map is always updated after placing/removing blocks
Note this is meaningless in dimensions other than the normal world Returns a number of how many blocks away there is rain fall. Does a cheap 2D bfs up to x blocks away. Returns 99 if none was found within given blocks Horizontal search distance, 4 default Vertical search distance, 1 default Returns the topmost non-rain-permeable position at given x/z coordinate. This map is always updated after placing/removing blocks
Note this is meaningless in dimensions other than the normal world Returns the map chunk at given chunk position Returns the map chunk at given chunk position Returns the map chunk at given block position Returns the position's current climate conditions WorldGenValues = values as determined by the worldgenerator, NowValues = additionally modified to take season, day/night and hemisphere into account When mode == ForSuppliedDateValues then supply here the date. Not used param otherwise Returns the position's climate conditions at specified date, making use of previously obtained worldgen climate conditions Fast shortcut method for the clound renderer Retrieves the wind speed for given position Retrieves the wind speed for given position Used by the chisel block when enough chiseled have been removed and the blocks light absorption changes as a result of that Call this on OnBlockBroken() when your block entity modifies the blocks light range. That way the lighting task can still retrieve the block entity before its gone. Add a decor block to the side of an existing block. Use air block (id 0) to remove a decor.
 True if the decor was sucessfully set Add a decor block to a specific sub-position on the side of an existing block. Use air block (id 0) to remove a decor.
 You can get this value via or via constructor or . It can include a subPosition for cave art etc. True if the decor was sucessfully set Get a list of all decors at this position null if this block has no decors. Otherwise a 6 element long list of decor blocks, any of which may be null if not set Get a list of all decors at this position null if this block position has no decors. Otherwise, a Dictionary with the index being the faceAndSubposition (subposition used for cave art etc.), see Retrieves a single decor at given position You can get this value via or via constructor or Removes all decors at given position, drops items if set If not null, breaks all the decor on given block face, otherwise the decor blocks on all sides are removed If not null breaks only this part of the decor for give face. You can get this value via or via constructor or True if a decor was removed Server: Marks this position as required for resending to the client Client: No effect Tests whether a side at the specified position is solid - testing both fluids layer (which could be ice) and solid blocks layer Used by World Edit to create previews, ships etc. The type of climate values you wish to receive The values generate during world generation, these are loosely considered as yearly averages The values at the current calendar time The values at the supplied calendar time, supplied as additional arg The values at the supplied calendar time, ignoring rainfall etc. Calling IBlockAccessor.GetClimateAt with this mode will never return a null ClimateCondition value, if it would be null it returns a ClimateCondition with a default 4 degrees temperature value The values at the supplied calendar time, ignoring forest cover etc. Calling IBlockAccessor.GetClimateAt with this mode will never return a null ClimateCondition value, if it would be null it returns a ClimateCondition with a default 4 degrees temperature value and no rain Useful for when you have to scan multiple times over the same set of blocks Pre-loads all blocks inside given area which can then be accessed very quickly using .GetBlock(). This method must be called before using GetBlock() Provides read/write access to the blocks of a world. Whether or not to do relighting on the chunk 0 = working on latest version, 1 = undo used one time, 2 = undo used 2 times, etc. 1 = perform 1 undo -1 = perform 1 redo Maximum Amount of undos you can perform. More states means more memory usage. Amount of currently stored history states Manually set the history state of a block for the to-be-comitted history state Useful for setting many blocks at once efficiently The full list of staged blocks that will get commited after calling Commit() If set to true, the methods GetBlock() and GetBlockId() will behave like GetStagedBlockId() until the next commit Gets the block for a not yet commited block. If no block has been staged for this pos the original block is returned Gets the block for a not yet commited block. If no block has been staged for this pos the original block is returned Implemented only by BlockAccessorMapChunkLoading Used to fix certain things like flowing water from the edge of a pasted schematic/selection when undone or /we delete is used Interface for creating instances Creates a block instance from given block class Returns the type of the registered block class or null otherwise Creates a block entity instance from given block entity class Creates a entity instance from given entity class Creates a entity instance from given entity type Creates an instance of a mountable that has been registered with api.RegisterMountable Creates a block behavior instance from given behavior code Creates a collectible behavior instance from given behavior code Returns the block entity behavior type if such is registered under supplied name Creates a block entity behavior instance for given block entity Returns the block behavior type registered for given name or null Returns the collectible behavior type registered for given name or null Creates a block behavior instance from given block class Creates an item instance from given item class Gets the registered item type or null if not registered Creates a json serializable version of an ITreeAttribute Returns the type for given BlockEntity class name as register in the ClassRegistry Returns the block entity class code if give Type is a registered block entity class Returns the entity class code if give Type is a registered entity class Creates a crop behavior instance from given block class This method needs to find your mountable based on the tree attribute data, which you can write to in IMountable.MountableToTreeAttributes() For example if its an entity, you will want to store the entity id, then this method can simply contain return world.GetEntityById(tree.GetLong("entityId")); API Methods common to the server and client Registers a recipe registry Registers a new color map. Typically used to color in-game blocks with a texture - i.e. climate and seasonal coloring Registers a non-block entity. Be sure to register it on the client and server side. Registers a non-block entity behavior. Be sure to register it on the client and server side. Register a new Blockclass. Must happen before any blocks are loaded. Be sure to register it on the client and server side. Class to register Name of the class Register a new crop behavior Register a new BlockEntity Class. Must happen before any blocks are loaded. Be sure to register it on the client and server side. Register a new Item Class. Must happen before any blocks are loaded. Be sure to register it on the client and server side. Registers a new collectible behavior class, which can be used for items or for blocks. Register a new block behavior class. Must happen before any blocks are loaded. Be sure to register it on the client and server side. 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. 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]"); Can be used to store non-persistent, game wide data. E.g. used for firewood piles to pregenerate all meshes only once during startup Returns the root path of the games data folder Returns the path to given foldername inside the games data folder. Ensures that the folder exists 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 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 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 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 Common API Components that are available on the server and the client. Cast to ICoreServerAPI or ICoreClientAPI to access side specific features. The local Logger instance. The command line arguments that were used to start the client or server application Returns if you are currently on server or on client Api component to register/trigger events Second API Component for access/modify everything game world related API Compoment for creating instances of certain classes, such as Itemstacks API for sending/receiving network packets API Component for loading and reloading one or multiple assets at once from the assets folder API Component for checking for and interacting with other mods and mod systems API for converting between registry object tags and tag ids, and for registering new tags Registers a new entity config for given entity class For handling events on the event bus Set to EnumHandling.Last to stop further propagation of the event For handling dirty chunks Triggered immediately when the server loads a chunk column from disk or generates a new one, in the SupplyChunks thread (not the main thread) Triggered when the server loaded a chunk column from disk or generated a new one Triggered just before a chunk column gets unloaded chunkX and chunkZ of the column (multiply with chunksize to get position). The Y component is zero Triggered when a server receives a gait update from a client-authoritative mount Triggered when the server loaded a map region from disk or generated a new one regionX and regionZ (multiply with region size to get block position) Triggered just before a map region gets unloaded regionX and regionZ (multiply with region size to get block position) Events that are available on the server and the client Called when a player changed dimension Triggered when block access is tested, allows you to override the engine response Triggered when a new entity spawned Triggered when a new entity got loaded (either spawned or loaded from disk) Triggered when a new entity despawned Called whenever a chunk was marked dirty (as in, its blocks or light values have been modified or it got newly loaded or newly created) Called whenever the server loaded from disk or newly generated a map region Called just before a map region is about to get unloaded. On shutdown this method is called for all loaded map regions. Called whenever any method calls world.BlockAccessor.GetClimateAt(). Used by the survival mod to modify the rainfall and temperature values to adjust for seasonal and day/night temperature variations. Be sure to also register to OnGetClimateForDate. Called whenever any method calls world.BlockAccessor.GetWindSpeedAt(). Used by the survival mod to set the wind speed Called when a player tries to gridcraft something There's 2 global event busses, 1 on the client and 1 on the server. This pushes an event onto the bus. Registers a listener on the event bus. This is intended for mods as the game engine itself does not push any events. The handler for the events Set this to a different value if you want to catch an event before/after another mod catches it If set, events only with given eventName are received Calls given method after every given interval until unregistered. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Calls given method after every given interval until unregistered. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. This overload includes an ErrorHandler callback, triggered if calling onGameTick throws an exception listenerId Calls given method after every given interval until unregistered. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Calls given method after supplied amount of milliseconds. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Calls given method after supplied amount of milliseconds. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. This overload can be used to signify callbacks which do no harm if registered while the game is paused (otherwise, registering a callback while paused will produce an error in logs, or an intentional exception in Developer Mode) listenerId Calls given method after supplied amount of milliseconds, lets you supply a block position to be passed to the method. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Removes a delayed callback Removes a game tick listener Can be used to execute supplied method a frame later or can be called from a seperate thread to ensure some code is executed in the main thread. Calling this method is thread safe. Task category identifier for the frame profiler Returns a normalized vector of the sun position at the players current location Returns a vector of the sun position at the players current location Returns a vector of the moon position at the players current location Returns a normalized color of the sun at the players current location A horizontal offset that is applied when reading the sky glow color at the players current location. Creates a greater variety of sunsets. Changes to a different value once per day (during midnight) Returns a value between 0 (no sunlight) and 1 (full sunlight) at the players current location Returns a value between 0 (no sunlight) and 1 (full sunlight) at the players current location If true, its currently dusk at the players current location Should return sin(solar altitude angle). i.e. -1 for 90 degrees far below horizon, 0 for horizon and 1 for vertical World x coordinate World z coordinate Current year progress, from 0..1 Current day progress, from 0..1 Main API for retrieving anything calender or astronomy related Assigned by the survival mod. Must return the hemisphere at give location Assigned by the survival mod. The calendar uses this method to determine the solar altitude at given location and time. If not set, the calendar uses a default value of about 0.75 Assigned by the survival mod. Must return the latitude for given position. If not set, the calendar uses a default value of 0.5
-1 for south pole, 0 for equater, 1 for north pole Retrieve the current daylight strength at given coordinates, the values are roughly beween 0 and 1.2f Retrieve the current daylight strength at given coordinates. The Y-Component is ignored Get the suns position in the sky at given date as a normalized vector Get the moons position in the sky at given date as a normalized vector The worlds current date, nicely formatted This acts as a multiplier on how much faster an ingame second passes by compared to a real life second. Affects physics, like the motion speed of waving grass. The default is 60, hence per default a day lasts 24 minutes, but it's also multiplied by CalendarSpeedMul which is 0.5 by default so the end result is 48 minutes per day This is the sum of all modifiers If you want to modify the time speed, set a value here To remove a previously added time speed modifier Amount of in-game seconds that have passed since the game started Amount of in-game hours that have passed since the game started Amount of in-game days that have passed since the game started A multiplier thats applied to the progression of the calendar. Set this to 0.1 and a day will last 10 times longer, does not affect physics. Amount of hours per day Amount of days per year Amount of days per month The current hour of the day as integer The current hour of the day as decimal Total passed hours since the beginning of the first year (january 1st 0:00) Total passed days since the beginning of the first year (january 1st 0:00) The current day of the year (goes from 0 to DaysPerYear) The current day of the year (goes from 0 to DaysPerYear) Returns the year. Every game begins with 1386 Returns the season at given position Returns the season at given position between 0..1, respects hemisphere Returns the hemisphere at given position Returns the current season in a value of 0 to 1 Adds given time to the calendar The current moonphase The current moonphase represented by number from 0..8 The moons current brightness (higher during full moon) The moons current size (larger during full moon) If non-null, will override the value retrieved by GetSeason(). Set to null to have seasons progress normally again. Can be used to adjust apparent time of day and season for rendering, e.g. to create a series of timelapse images; restore to 0 when done List of all claims on the server. Same as WorldManager.SaveGame.Claims. Checks with the permission system if given player has use or place/break permissions on supplied position. Returns always true when called on the client! Same as but also sends an error message to the player and executes a MarkDirty() event the block. Returns always true when called on the client! Get all claims registered at this position Add a new claim. Remove a claim. Returns false if no such claim was registered Interface to the client's and server's event, debug and error logging utilty. If true, will also print to Diagnostics.Debug. Fired each time a new log entry has been added. Removes any handler that registered to the EntryAdded event. This method is called when the client leaves a world or server shuts down. Adds a new log entry with the specified log type, format string and arguments. Adds a new log entry with the specified log type and message. Logs an exception with the specified log type. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Convenience method for logging exceptions in try/catch blocks Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Convenience method for logging exceptions in try/catch blocks Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Convenience method for logging exceptions in try/catch blocks Adds a new log entry with the specified format string and arguments. Adds a new log entry with the specified message. Base implementation for which implements all methods besides a new abstract method . This is the only method necessary to be overridden by the implementing class, actually does the logging as necessary. Remove the full path from the stacktrace of the machine that compiled the code Holds 2 dimensional data for one chunk column The map region this map chunk resides in The current world generation pass this chunk column is in Server: Can be used to store custom data along with the map chunk Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Can be used to retrieve custom data from the map chunk (as previously set by SetModdata) Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Allows setting of arbitrary, permanently stored moddata of this map chunk. Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Removes the permanently stored data. Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Retrieve arbitrary, permanently stored mod data Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Allows setting of arbitrary, permanantly stored moddata of this map chunk. Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Retrieve arbitrary, permantly stored mod data Client: Not implemented. Map chunk Moddata is not synced from server to client Default value The position of the last block that is not rain permeable before the first airblock The position of the last block before the first airblock before world gen pass Vegetation The rock block id of the topmost rock layer The highest position of any non-air block Causes the TTL counter to reset so that it the mapchunk does not unload. No effect when called client side. Tells the server that it has to save the changes of this chunk to disk. No effect when called client side. Block position of the structure Code as defined in the WorldGenStructure object Group as defined in the WorldGenStructure object If this flag is set, trees and shrubs will not generate inside the structure's bounding box If this flag is set, rivulets will not generate inside the structure's bounding box 2D Map data for a 16x16 area of chunk columns. Holds a few maps for the chunk generation. Density maps for block patches Currently unuseds Holds a shrub density map Holds a forest density map Holds a beach strength map Holds the landform indices Holds temperature and rain fall.
16-23 bits = Red = temperature
8-15 bits = Green = rain
0-7 bits = Blue = unused Holds the geologic province indices Holds the rock strata noise maps Holds the raw mod data. Holds the mod mappings. Gets the ore map for the given item. List of structures that were generated in this region Server: Allows setting of arbitrary, permanently stored moddata of this map region. Client: Not implemented. Map chunk Moddata is not synced from server to client Use SerializerUtil to encode your data to bytes Server: Removes the permanently stored data. Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Retrieve arbitrary, permanently stored mod data Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Allows setting of arbitrary, permanantly stored moddata of this map region. Client: Not implemented. Map chunk Moddata is not synced from server to client Server: Retrieve arbitrary, permantly stored mod data Client: Not implemented. Map chunk Moddata is not synced from server to client A thread-safe way to add a new GeneratedStructure, also marks DirtyForSaving = true Provides read/write access to the blocks of a movable mini-dimension. If this matches the subDimensionId, it indicates that this is a blocks preview minidimension Sends dirty chunks to nearby clients Clears this mini-dimension (and empties any chunks but does not unload them) ready for re-use Unload any chunks which are still empty after the dimension has been re-used Used when rendering Gets a collection of all enabled mods. Gets a collection of all loaded and enabled mod systems. Gets the enabled mod with the specified mod ID (domain). Returns null if no mod with that mod ID was found. Returns if the mod with the specified mod ID (domain) is enabled. Gets a loaded mod system with the specified full name, that is the namespace and class name, for example "Vintagestory.ServerMods.Core" for the survival mod. Returns null if no mod with that name was found. Gets a loaded mod system with the specified type. Returns null if no mod of that type was found. Returns if the mod system with the specified full name is loaded and enabled. On server side: blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
On client side: all tags are received from server along side blocks, times, and entities, an available in 'AssetsFinalize' stage.
Tags can be converted to tag array or tag id as soon as it is registered.
Tags can be registered only on server side no later than 'AssetsFinalize' stage. Registers new entity tags. Should be called only on server side. Should be called no later than 'AssetsFinalize' stage. Registers new item tags. Should be called only on server side. Should be called no later than 'AssetsFinalize' stage. Registers new block tags. Should be called only on server side. Should be called no later than 'AssetsFinalize' stage. Converts a list of entity tags to their corresponding tag IDs.
If removeUnknownTags is true, any unknown tags will be removed from the list.
Result is sorted in ascending order. List of entity tags If set to true, not registered tags wont be included in the result List of tag ids sorted in ascending order Converts a list of item tags to their corresponding tag IDs.
If removeUnknownTags is true, any unknown tags will be removed from the list.
Result is sorted in ascending order. List of item tags If set to true, not registered tags wont be included in the result List of tag ids sorted in ascending order Converts a list of block tags to their corresponding tag IDs.
If removeUnknownTags is true, any unknown tags will be removed from the list.
Result is sorted in ascending order. List of block tags If set to true, not registered tags wont be included in the result List of tag ids sorted in ascending order Converts list of entity tags to tags array. Unknown tags are ignored.
Blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
 List of entity tags Tag array suitable for quick comparisons Converts list of item tags to tags array. Unknown tags are ignored.
Blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
 List of item tags Tag array suitable for quick comparisons Converts list of block tags to tags array. Unknown tags are ignored.
Blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
 List of block tags Tag array suitable for quick comparisons Returns tag id of the entity tag. If the tag is not registered, it will return 0.
Blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
 Entity tag tag id Returns tag id of the item tag. If the tag is not registered, it will return 0.
Blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
 Item tag tag id Returns tag id of the block tag. If the tag is not registered, it will return 0.
Blocks, items, entities tags and tags from preloaded-tags.json are registered after 'AssetsLoaded' and before 'AssetsFinalize' stages.
 Block tag tag id Returns tag by entity tag id. If the tag id is not registered, it will return empty string. Entity tag id tag Returns tag by item tag id. If the tag id is not registered, it will return empty string. Item tag id tag Returns tag by block tag id. If the tag id is not registered, it will return empty string. Block tag id tag Loads tags from 'TagRegistry.TagsAssetPath' assets from all domains. Is only used by 'RegistryObjectTypeLoader'. Not meant to be called by mods. Important interface to access the game world. The current world config The default spawn position as sent by the server (usually the map middle). Does not take player specific spawn point into account Gets the frame profiler utility. The api interface The land claiming api interface Returns a list all loaded chunk positions in the form of a long index. Code to turn that into x/y/z coords: Vec3i coords = new Vec3i( (int)(chunkIndex3d % ChunkMapSizeX), (int)(chunkIndex3d / ((long)ChunkMapSizeX * ChunkMapSizeZ)), (int)((chunkIndex3d / ChunkMapSizeX) % ChunkMapSizeZ) ); Retrieving the list is not a very fast process, not suggested to be called every frame Returns a list all loaded chunk positions in the form of a long index The currently configured block light brightness levels The currently configured sun light brightness levels The currently configured sea level (y-coordinate) The world seed. Accessible on the server and the client A globally unique identifier for this savegame The currently configured max sun light level Whether the current side (client/server) is in entity debug mode Loaded game assets Logging Utility The current side (client/server) Access blocks and other world data from loaded chunks, fault tolerant Fault tolerant bulk block access to the worlds block data. Since this is a single bulk block access instance the cached data is shared for everything accessing this method, hence should only be accessed from the main thread and any changed comitted within the same game tick. You can however use the WorldManager api to get your own instance of a bulk block accessor Interface to create instance of certain classes Interface to access the game calendar. On the server side only available after run stage 'LoadGamePre' (before that it is null) For collision testing in the main thread Just a random number generator. Makes use of ThreadLocal for thread safety. Amount of milliseconds ellapsed since startup List of all loaded blocks and items without placeholders List of all loaded blocks. The array index is the block id. Some may be null or placeholders (then block.code is null). Client-side none are null, what was null return as air blocks. List of all loaded items. The array index is the item id. Some may be placeholders (then item.code is null). Server-side, some may be null; client-side, a check for item == null is not necessary. List of all loaded entity types. List of the codes of all loaded entity types, in the AssetLocation short string format (e.g. "creature" for entities with domain game:, "domain:creature" for entities with other domains) List of all loaded crafting recipes Retrieve a previously registered recipe registry The range in blocks within a client will receive regular updates for an entity Retrieve the item class from given item id Retrieve the block class from given block id Returns all blocktypes matching given wildcard Returns all item types matching given wildcard Retrieve the item class from given item code. Will return null if the item does not exist. Retrieve the block class from given block code. Will return null if the block does not exist. Logs a warning if block does not exist Retrieve the entity class from given entity code. Will return null if the entity does not exist. Spawns a dropped itemstack at given position. Will immediately disappear if stacksize==0 Returns the entity spawned (may be null!) Spawns a dropped itemstack at given position. Will immediately disappear if stacksize==0 Returns the entity spawned (may be null!) Creates a new entity. It's the responsibility of the given Entity to call set its EntityType. This should be done inside its Initialize method before base.Initialize is called. Like SpawnEntity() but sends out the entity spawn and motion packets to nearby clients immediately. Use this e.g. for more responsive projectiles Loads a previously created entity into the loadedEntities list. Used when a chunk is loaded. Removes an entity from its old chunk and adds it to the chunk with newChunkIndex3d Retrieve all entities within given range and given matcher method. If now matcher method is supplied, all entities are returned. Retrieve all entities within a cuboid bound by startPos and endPos. If now matcher method is supplied, all entities are returned. Retrieve all players within given range and given matcher method. This method is faster than when using GetEntitiesAround with a matcher for players Retrieve the nearest entity within given range and given matcher method Retrieve an entity by its unique id, returns null if no such entity exists or hasn't been loaded Retrieves the first found entity that intersects any of the supplied collisionboxes offseted by basePos. This is a helper method for you to determine if you can place a block at given position. You can also implement it yourself with intersection testing and GetEntitiesAround() Find the nearest player to the given position. Thread safe. x coordinate y coordinate z coordinate ID of the nearest player Gets a list of all online players. Warning: Also returns currently connecting player whose player data may not have been fully initialized. Check for player.ConnectionState to avoid these. Array containing the IDs of online players Gets a list of all players that connected to this server at least once while the server was running. When called client side you will receive the same as AllOnlinePlayers Array containing the IDs of online players Retrieves the worldplayer data object of given player. When called server side the player does not need to be connected. Plays given sound at given position. The sound path, without sounds/ prefix or the .ogg ending If this call is made on client and on server, set this the causing playerUID to prevent double playing. Essentially dualCall will play the sound on the client, and send it to all other players except source client The range at which the gain will be attenuated to 1% of the supplied volume Plays given sound at given position - dimension aware. Plays at the center of the BlockPos The sound path, without sounds/ prefix or the .ogg ending How much above or below the central Y position of the block to play If this call is made on client and on server, set this the causing playerUID to prevent double playing. Essentially dualCall will play the sound on the client, and send it to all other players except source client The range at which the gain will be attenuated to 1% of the supplied volume Plays given sound at given position. The sound path, without sounds/ prefix or the .ogg ending If this call is made on client and on server, set this the causing playerUID to prevent double playing. Essentially dualCall will play the sound on the client, and send it to all other players except source client The range at which the gain will be attenuated to 1% of the supplied volume Plays given sound at given position. Plays given sound at given position. Plays given sound at given player position. The sound path, without sounds/ prefix or the .ogg ending If this call is made on client and on server, set this the causing playerUID to prevent double playing. Essentially dualCall will play the sound on the client, and send it to all other players except source client The range at which the gain will be attenuated to 1% of the supplied volume Plays given sound only for given player. Useful when called server side, for the client side there is no difference over using PlaySoundAt or PlaySoundFor The sound path, without sounds/ prefix or the .ogg ending The range at which the gain will be attenuated to 1% of the supplied volume Spawn a bunch of particles If this call is made on client and on server, set this to the causing playerUID to prevent double spawning. Essentially dualCall will spawn the particles on the client, and send it to all other players except source client Spawn a bunch of particles If this call is made on client and on server, set this to the causing playerUID to prevent double spawning. Essentially dualCall will spawn the particles on the client, and send it to all other players except source client Spawn a bunch of particles colored by the block at given position The position of the block to take the color from The position where the particles should spawn If this call is made on client and on server, set this to the causing playerUID to prevent double spawning. Essentially dualCall will spawn the particles on the client, and send it to all other players except source client Spawn a bunch of particles colored by given itemstack The position where the particles should spawn If this call is made on client and on server, set this to the causing playerUID to prevent double spawning. Essentially dualCall will spawn the particles on the client, and send it to all other players except source client Shoots out a virtual ray at between given positions and stops when the ray hits a block or entity selection box. The block/entity it struck first is then returned by reference. Can be used to ignore certain blocks. Return false to ignore Can be used to ignore certain entities. Return false to ignore Shoots out a virtual ray at between given positions and stops when the ray hits a block or entity intersection box supplied by given supplier. The block/entity it struck first is then returned by reference. Can be used to ignore certain blocks. Return false to ignore Can be used to ignore certain entities. Return false to ignore Shoots out a virtual ray at given position and angle and stops when the ray hits a block or entity selection box. The block/entity it struck first is then returned by reference. Can be used to ignore certain blocks. Return false to ignore Can be used to ignore certain entities. Return false to ignore Shoots out a given ray and stops when the ray hits a block or entity selection box. The block/entity it struck first is then returned by reference. Can be used to ignore certain entities. Return false to ignore Calls given method after every given interval until unregistered. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Removes a game tick listener Calls given method after supplied amount of milliseconds. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Calls given method after supplied amount of milliseconds. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. Ignores any subsequent registers for the same blockpos while a callback is still in the queue. Used e.g. for liquid physics to prevent unnecessary multiple updates listenerId Calls given method after supplied amount of milliseconds, lets you supply a block position to be passed to the method. The engine may call your method slightly later since these event are handled only during fixed interval game ticks. listenerId Returns true if given client has a privilege. Always returns true on the client. Removes a delayed callback Utility for testing intersections. Only access from main thread. Sends given player a list of block positions that should be highlighted for multiple highlights use a different number Sends given player a list of block positions that should be highlighted (using a default color) for multiple highlights use a different number When arbitrary, the blocks list represents the blocks to be highlighted. When Cube the blocks list should contain 2 positions for start and end Retrieve a customized interface to access blocks in the loaded game world. Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after a call to SetBlock and the light values changed by that Log an error message if GetBlock/SetBlock was called to an unloaded chunk If strict, crashes the server if a unloaded chunk was crashed, prints an exception and exports a png image of the current loaded chunks Retrieve a customized interface to access blocks in the loaded game world. Does not to relight/sync on a SetBlock until Commit() is called. On commit all touched blocks are relit/synced at once. This method should be used when setting many blocks (e.g. tree generation, explosion, etc.). Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after the a call to SetBlock and the light values changed by that Retrieve a customized interface to access blocks in the loaded game world. Does not relight. On commit all touched blocks are updated at once. This method is currently used for the snow accumulation system Retrieve a special Bulk blockaccessor which can have the chunks it accesses directly provided to it from a loading mapchunk. On commit all touched blocks are updated at once. This method is currently used for the snow accumulation system Same as GetBlockAccessorBulkUpdate, additionally, each Commit() stores the previous state and you can perform undo/redo operations on these. Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after a call to SetBlock and the light values changed by that Same as GetBlockAccessor but you have to call PrefetchBlocks() before using GetBlock(). It pre-loads all blocks in given area resulting in faster GetBlock() access Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after a call to SetBlock and the light values changed by that Same as the normal block accessor but remembers the previous chunk that was accessed. This can give you a 10-50% performance boosts when you scan many blocks in tight loops DONT FORGET: Call .Begin() before getting/setting in a tight loop. Not calling it can cause the game to crash This block accessor is *read only* and does not use lock() or chunk.Unpack() in order to make it very fast. This comes at the cost of sometimes reading invalid data (block id = 0) when the chunk is packed or being packed. Retrieves the first solid block, if that one is empty, retrieves the first fluid block Same as ClearBlocks but initialises the chunkdata palette, so that SetBlockUnsafe can be used (useful in worldgen) Efficiently bulk-set a single block id in a chunk throughout a y-layer. lenX will be ignored (always treated as 32), the y-position is specified in index3d, the width lenZ will be respected Not threadsafe, used only in cases where we know that the chunk already has a palette (e.g. in worldgen when replacing rock with other blocks) Used to place blocks into the fluid layer instead of the solid blocks layer; calling code must do this Like get (i.e. this[]) but not threadsafe - only for use where setting and getting is guaranteed to be all on the same thread (e.g. during worldgen) Enter a locked section for bulk block reads from this ChunkData, using Unsafe read methods Leave a locked section for bulk block reads from this ChunkData, using Unsafe read methods Does this chunk contain any examples of the specified block?
(If the result is false, this is a very fast lookup because it quickly scans the blocks palette, not every block individually.) Populates the list with all block IDs which are present in this chunk. The list may contain false positives (i.e. blocks which used to be here but were removed) so that's why it's called a "Fuzzy" list. There will be no false negatives, therefore useful as a first-pass filter when scanning chunks for various types of block e.g. ITickable True if fully initialized Can be used to set a chunk as invisible, probably temporarily (e.g. for the Timeswitch system) Holds a reference to the current map data of this chunk column Holds all the blockids for each coordinate, access via index: (y * chunksize + z) * chunksize + x Use instead Holds all the lighting data for each coordinate, access via index: (y * chunksize + z) * chunksize + x Faster (non-blocking) access to blocks at the cost of sometimes returning 0 instead of the real block. Use if you need reliable block access. Also should only be used for reading. Currently used for the particle system. An array holding all Entities currently residing in this chunk. This array may be larger than the amount of entities in the chunk. Actual count of entities in this chunk An array holding block Entities currently residing in this chunk. This array may be larger than the amount of block entities in the chunk. Blockdata and Light might be compressed, always call this method if you want to access these Like Unpack(), except it must be used readonly: the calling code promises not to write any changes to this chunk's blocks or lighting Like Unpack_ReadOnly(), except it actually reads and returns the block ID at index
(Returns 0 if the chunk was disposed) Like Unpack_ReadOnly(), except it actually reads and returns the Light at index
(Returns 0 if the chunk was disposed) A version of Unpack_AndReadLight which also returns the lightSat
(Returns 0 if the chunk was disposed) Marks this chunk as modified. If called on server side it will be stored to disk on the next autosave or during shutdown, if called on client not much happens (but it will be preserved from packing for next ~8 seconds) Marks this chunk as recently accessed. This will prevent the chunk from getting compressed by the in-memory chunk compression algorithm Returns a list of a in-chunk indexed positions of all light sources in this chunk Whether this chunk got unloaded Adds an entity to the chunk. The entity to add. Removes an entity from the chunk. the ID for the entity Whether or not the entity was removed. Allows setting of arbitrary, permanantly stored moddata of this chunk. When set on the server before the chunk is sent to the client, the data will also be sent to the client. When set on the client the data is discarded once the chunk gets unloaded Removes the permanently stored data. Retrieve arbitrary, permantly stored mod data Allows setting of arbitrary, permanantly stored moddata of this chunk. When set on the server before the chunk is sent to the client, the data will also be sent to the client. When set on the client the data is discarded once the chunk gets unloaded Retrieve arbitrary, permantly stored mod data Can be used to store non-serialized mod data that is only serialized into the standard moddata dictionary on unload. This prevents the need for constant serializing/deserializing. Useful when storing large amounts of data. Is not populated on chunk load, you need to populate it with stored data yourself using GetModData() Retrieve a block from this chunk ignoring ice/water layer, performs Unpack() and a modulo operation on the position arg to get a local position in the 0..chunksize range (it's your job to pick out the right chunk before calling this method) As GetLocalBlockAtBlockPos except lock-free, use it inside paired LockForReading(true/false) calls Retrieve a block entity from this chunk Sets a decor block to the side of an existing block. Use air block (id 0) to remove a decor.
 False if there already exists a block in this position and facing Sets a decor block to a specific sub-position on the side of an existing block. Use air block (id 0) to remove a decor.
 False if there already exists a block in this position and facing If allowed by a player action, removes all decors at given position and calls OnBrokenAsDecor() on all selected decors and drops the items that are returned from Block.GetDrops() If null, all the decor blocks on all sides are removed If not null breaks only this part of the decor for give face. Requires side to be set. Removes a decor block from given position, saves a few cpu cycles by not calculating index3d When set to true it will call block.OnBrokenAsDecor(...) which is used to drop the decors of that block Set entire Decors for a chunk - used in Server->Client updates Adds extra selection boxes in case a decor block is attached at given position Only to be implemented client side Returns the higher light absorption between solids and fluids block layers For bulk chunk GetBlock operations, allows the chunkDataLayers to be pre-locked for reading, instead of entering and releasing one lock per read
Best used mainly on the server side unless you know what you are doing. The client-side Chunk Tesselator can need read-access to a chunk at any time so making heavy use of this would cause rendering delays on the client
Make sure always to call ReleaseBulkReadLock() when finished. Use a try/finally block if necessary, and complete all read operations within 8 seconds For bulk chunk GetBlock operations, allows the chunkDataLayers to be pre-locked for reading, instead of entering and releasing one lock per read
Make sure always to call ReleaseBulkReadLock() when finished. Use a try/finally block if necessary, and complete all read operations within 8 seconds Free up chunk data and pool Represents a mod dependency requirement of one mod for another. The required mod id (domain) of this dependency. The minimum version requirement of this dependency. May be empty if the no specific version is required. Creates a new ModDependancy object. The ID of the required mod. The version of the required mod (default: empty string.) Returns the Mod Dependancy as a string. Applied to a mod assembly multiple times for each required dependency. Superseded by this mod's "modinfo.json" file, if available. The required mod id (domain) of this dependency. The minimum version requirement of this dependency. May be empty if the no specific version is required. Describes the type of a mod. Allows easy recognition and limiting of what any particular mod can do. Makes only theme changes (texture, shape, sound, music) to existing game or mod assets / content without adding new content or code. Can modify any existing assets, or add new content, but no code. Can modify existing assets, add new content and make use of C# source files (.cs) and pre-compiled assemblies (.dll). Meta data for a specific mod folder, archive, source file or assembly. Either loaded from a "modinfo.json" or from the assembly's . The type of this mod. Can be "Theme", "Content" or "Code". If the mod is a texture pack that changes topsoil grass textures, define the texture size here The name of this mod. For example "My Example Mod". The mod id (domain) of this mod. For example "myexamplemod". (Optional. Uses mod name (converted to lowercase, stripped of whitespace and special characters) if missing.) The version of this mod. For example "2.10.4". (optional) The network version of this mod. Change this number when a user that has an older version of your mod should not be allowed to connected to server with a newer version. If not set, the version value is used. The path relative to the mod root to load the icon from. If this is not set, the game will also try to load "./modicon.png" before giving up. A short description of what this mod does. (optional) Location of the website or project site of this mod. (optional) Names of people working on this mod. (optional) Names of people contributing to this mod. (optional) Which side(s) this mod runs on. Can be "Server", "Client" or "Universal". (Optional. Universal (both server and client) by default.) If set to false and the mod is universal, clients don't need the mod to join. (Optional. True by default.) If set to false and the mod is universal, the mod is not disabled if it's not present on the server. (Optional. True by default.) List of mods (and versions) this mod depends on. Not exposed as a JsonProperty, only coded mods can set this to true Attempts to convert the specified mod name to a mod ID, stripping any non-alphanumerical (including spaces and dashes) and lowercasing letters. Returns whether the specified domain is valid. Tests if the string is non-null, has a length of at least 1, starts with a basic lowercase letter and contains only lowercase letters and numbers. Applied to a mod assembly to provide additional meta data information about a code mod. Superseded by "modinfo.json" file, if available. The name of this mod. For example "My Example Mod". The mod ID (domain) of this mod. For example "myexamplemod". The version of this mod. For example "2.10.4". (optional) Is this mod part of the core game, i.e. vanilla Vintage Story? (optional)
Only affects whether the player is given a warning when attempting to disable this mod.
Mods other than VSSurvival, VSEssentials, VSCreative should not use this, obviously... The network version of this mod. Change this number when a user that has an older version of your mod should not be allowed to connected to server with a newer version. If not set, the version value is used. A short description of what this mod does. (optional) Location of the website or project site of this mod. (optional) Names of people working on this mod. (optional) Names of people contributing to this mod. (optional) Which side(s) this mod runs on. Can be "Server", "Client" or "Universal". (Optional. Universal (both server and client) by default.) If set to false and the mod is universal, clients don't need it to join. (Optional. True (required) by default.) If set to false and the mod is universal, the mod is not disabled if it's not present on the server. (Optional. True by default.) Base of a system, which is part of a code mod. Takes care of setting up, registering and handling all sorts of things. You may choose to split up a mod into multiple distinct systems if you so choose, but there may also be just one. Gets the this mod system is part of. Returns if this mod should be loaded for the given app side. Returns if this mod should be loaded for the given app side, called by ShouldLoad(ICoreApi api) If you need mods to be executed in a certain order, adjust this methods return value.
The server will call each Mods StartPre() and Start() methods in ascending order of each mods execute order value. And thus, as long as every mod registers it's event handlers in the Start() method, all event handlers will be called in the same execution order.
Default execute order of some survival mod parts
Worldgen:
- GenTerra: 0
- RockStrata: 0.1
- Deposits: 0.2
- Caves: 0.3
- Blocklayers: 0.4
AssetsLoaded event
- JsonPatch loader: 0.05
- Load hardcoded mantle block: 0.1
- Block and Item Loader: 0.2
- Recipes (Smithing, Knapping, Clayforming, Grid recipes, Alloys) Loader: 1
 Called during intial mod loading, called before any mod receives the call to Start() Start method, called on both server and client after all mods already received a call to StartPre(), but before Blocks/Items/Entities/Recipes etc are loaded and some time before StartServerSide / StartClientSide.
Typically used to register for events and network packets etc
Typically also used in a mod's core to register the classes for your blocks, items, entities, blockentities, behaviors etc, prior to loading assets

Do not make calls to api.Assets at this stage, the assets may not be found, resulting in errors (even if the json file exists on disk). Use AssetsLoaded() stage instead. Called on the server or the client; implementing code may need to check which side it is.
On a server, called only after all mods have received Start(), and after asset JSONs have been read from disk and patched, but before runphase ModsAndConfigReady.
Asset files are now available to load using api.Assets.TryGet() calls or similar. If your execute order is below 0.2, blocks and items are not yet registered at this point, if below 0.6 recipes are not yet registered. When called on a server, all Block.OnLoaded() methods etc. have already been called, this is for any final asset set-up steps to be done after that. See VSSurvivalMod system BlockReinforcement.cs for an example. Full start to the mod on the client side.
Note, in multiplayer games, the server assets (blocks, items, entities, recipes) have not yet been received and so no blocks etc. are yet registered
For code that must run only after we have blocks, items, entities and recipes all registered and loaded, add your method to event BlockTexturesLoaded Full start to the mod on the server side

Note: preferably, your code which adds or updates behaviors or attributes or other fixed properties of any block, item or entity, should have been run before now. For example, code which needs to do that could be placed in an overridden AssetsFinalize() method. See VSSurvivalMod system BlockReinforcement.cs for an example. If this mod allows runtime reloading, you must implement this method to unregister any listeners / handlers Path and name Determines wether it will be used on server, client or both. Temporary solution to not change block types. Will be changed Gets the asset category by code name The code name for the asset category. An asset category. For performance, don't build and store new concatenated strings for every block variant, item and entity, when these will only be used (if ever) for error logging Store references to the source strings, to be able to build a logging string later if necessary Defines a complete path to an assets, including it's domain. Includes an extra Source field for debugging. The source of a given asset. Used to avoid duplication when loading colormaps and shapes Defines a complete path to an assets, including it's domain. In JSON assets, asset locations are represented as single strings in the form "domain:path". To access an asset in the vanilla game, use the domain 'game'. "code": "game:vegetable-cookedcattailroot", Create a new AssetLocation from a single string (e.g. when parsing an AssetLocation in a JSON file). If no domain is prefixed, the default 'game' domain is used. This ensures the domain and path in the created AssetLocation are lowercase (as the input string could have any case) Helper function to resolve path dependancies. Full path The mod domain to get The resulting path to get Create a new AssetLocation with given domain and path: for efficiency it is the responsibility of calling code to ensure these are lowercase Create a new AssetLocation if a non-empty string is provided, otherwise return null. Useful when deserializing packets Create an Asset Location from a string which may optionally have no prefixed domain: - in which case the defaultDomain is used. This may be used to create an AssetLocation from any string (e.g. from custom Attributes in a JSON file). For safety and consistency it ensures the domainAndPath string is lowercase. BUT: the calling code has the responsibility to ensure the defaultDomain parameter is lowercase (normally the defaultDomain will be taken from another existing AssetLocation, in which case it should already be lowercase). Returns true if this is a valid path. For an asset location to be valid it needs to have any string as domain, any string as path, the domain may not contain slashes, and the path may not contain 2 consecutive slashes Returns the n-th path part Gets the category of the asset. Whether or not the Asset has a domain. Gets the name of the asset. Removes the file ending from the asset path. Returns the code of the last variant in the path, for example for a path of "water-still-7" it would return "7" Clones this asset. the cloned asset. Clones this asset in a way which saves RAM, if the calling code created the AssetLocation from JSON/deserialisation. Use for objects expected to be held for a long time - for example, building Blocks at game launch (at the cost of slightly more CPU time when creating the Clone()) Makes a copy of the asset with a modified path. Sets the path of the asset location the new path to set. The modified AssetLocation Sets the last part after the last / Converts a collection of paths to AssetLocations. The names of all of the locations The AssetLocations for all the names given. Convenience method and aids performance, avoids double field look-up Represents a loaded asset from the assets folder The assets Filename The AssetLocation of the asset. The origin informaton of the asset. The file contents in binary format If the asset is a json file you can use this convenience method to turn it into an object Attempts to convert the asset into the given type. Settings for the Json Serializer. Turns the binary data into a UTF-8 string. Use for text files. Turns the binary data into a Bitmap. Use for .png images. Does not work on other image formats. Whether or not the asset is currently loaded. Set to true if the asset has been patched by JsonPatchLoader - if so, we don't want to unload it Takes care loading, reloading and managing all files inside the assets folder. All asset names and paths are always converted to lower case. All assets found in the assets folder Returns true if given asset exists in the list of loaded assets Adds a runtime asset to the game, curently used by ModCompatiblityUtil. Allows you do add an asset found at but loaded from path .Path. Retrieves an asset from given path within the assets folder. Throws an exception when the asset does not exist. Remember to use lower case paths. Retrieves an asset from given path within the assets folder. Returns null when the asset does not exist. Remember to use lower case paths.

Mods must not call TryGet to get assets before AssetsLoaded stage in a ModSystem - do not load assets in the Start() method! (Or if you absolutely have to load assets in Start(), use IAssetManager.Get(), but it will throw an exception for anything except a base asset.) Returns all assets inside given domain with the given path. If no domain is specified, all domains will be searched. The returned list is considered unsorted. Whether it should load the contents of this asset Returns all assets inside given category with the given path. If no domain is specified, all domains will be searched. The returned list is considered unsorted. See class Searches for all assets in given basepath and uses Newtonsoft.Json to automatically turn them into objects. Will log an error to given ILogger if it can't parse the json file and continue with the next asset. Remember to use lower case paths. If no domain is specified, all domains will be searched. The returned list is considered unsorted. Returns all asset locations that begins with given path and domain. If no domain is specified, all domains will be searched. The returned list is considered unsorted. Retrieves an asset from given path within the assets folder and uses JSON.NET to automatically turn them into objects. Throws an exception when the asset does not exist or the conversion failed. Remember to use lower case paths. Reloads all assets in given base location path. It returns the amount of the found locations. Reloads all assets in given base location path. It returns the amount of the found locations. Returns all origins in the priority order. Highest (First) to Lowest (Last) Loads the asset into memeory. The asset to be loaded Attempts to load the asset. Returns false if it fails. The asset to be loaded. Returns all assets of the given category which can be found in this origin Returns all assets of the given base location path which can be found in this origin Resource packs are not allowed to affect gameplay Represents a mod in the mod manager. May contain zero to multiple instances within it. Gets the origin file type of the mod (.cs, .dll, .zip or folder). Gets the full path to where this mod originated from, including file name. Gets the file name of this mod. Gets the info of this mod. Found either as "modinfo.json" in the of the mod's folder or archive, or in the case of raw .cs and .dll files, using the on the assembly. Holds the icon of this mod. Found as "modicon.png" in the root of the mod's folder or archive. May be null. Gets the logger associated with this mod. Gets a collection of systems belonging to this mod. Represents the origin file type of the mod. A single .cs source file. (Code mod without assets.) A single .dll source file. (Code mod without assets.) A .zip archive able to contain assets and code files. A folder able to contain assets and code files. This value is update once the config is loaded and the Sealevel is known Temperature conversion factor used to get real temperatures from the climate's temperature int Used to convert from real temperature range float [-50 , 40] to int [0 , 255] Convert from real temperature range float [-50 , 40] to int [0 , 255] Convert from int [0 , 255] range to real temperature range float [-20 , 40] The distToSealevel/1.5f is also hardcoded in shaderincluds/colormap.vsh Convert from int [0 , 255] range to real temperature range float [-20 , 40] The distToSealevel/1.5f is also hardcoded in shaderincluds/colormap.vsh Convert from int [0 , 255] range to real temperature range float [-50 , 40] The distToSealevel/1.5f is also hardcoded in shaderincluds/colormap.vsh This exists since the client had a different value for min Convert from int [0 , 255] range to real temperature range int [-20 , 40] The distToSealevel/1.5f is also hardcoded in shaderincluds/colormap.vsh Basic class for a placeable block Default Full Block Collision Box Default Collision boxes (and also Selection boxes) array containing just the Default Collision Box This is standard for most solid blocks in the game. Since it is in practice immutable, all blocks can use a single copy of the same array This will help both RAM performance (avoids duplicate copies) and physics tick performance (this commonly accessed object can be well cached) Returns the block id Returns EnumItemClass.Block Return true if this block should be stored in the fluids layer in chunks instead of the solid blocks layer (e.g. water, flowing water, lake ice) Return non-null if this block should have water (or ice) placed in its position in the fluids layer when updating from 1.16 to 1.17 Unique number of the block. Same as . This number depends on the order in which the blocks are order. The numbering is however always ensured to remain the same on a per world basis. If not set to JSON it will use an efficient hardcoded model During which render pass this block should be rendered Currently not used Walk speed when standing or inside this block Drag multiplier applied to entities standing on it If true, players can target individual selection boxes of the block The sounds played for this block during step, break, build and walk. Use GetSounds() to query if not performance critical. Data thats passed on to the graphics card for every vertex of the blocks model A bit uploaded to the shader to add a frost overlay below freezing temperature For light blocking blocks. Any value above 32 will completely block all light. If true, when the player holds the sneak key and right clicks this block, calls the blocks OnBlockInteractStart first, the items OnHeldInteractStart second. Without it the order is reversed. A value usually between 0-9999 that indicates which blocks may be replaced with others. - Any block with replaceable value above 5000 will be washed away by water - Any block with replaceable value above 6000 will replaced when the player tries to place a block Examples: 0 = Bedrock 6000 = Tallgrass 9000 = Lava 9500 = Water 9999 = Air 0 = nothing can grow, 10 = some tallgrass and small trees can be grow on it, 100 = all grass and trees can grow on it The mining tier required to break this block How long it takes to break this block in seconds. Use GetResistance() to query if not performance critical. A way to categorize blocks. Used for getting the mining speed for each tool type, amongst other things. Use GetBlockMaterial() to query if not performance critical. Random texture selection - whether or not to use the Y axis during randomization (for multiblock plants) If true then the block will be randomly offseted by 1/3 of a block when placed If true, the block will render with a UV offset enabling it to use the "other half" of a 64 x 64 texture on each alternate block position (e.g. Redwood trunk) Bit flags for the direction in which the alternatingVOffset is to be applied e.g. 0x30 to apply alternatingVOffset as the y position moves up and down The block shape to be used when displayed in the inventory GUI, held in hand or dropped on the ground
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) The default json block shape to be used when drawtype==JSON The additional shape elements seen only at close distance ("LOD0"). For example, see leaves
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) The alternative simplified shape seen at far distance ("LOD2"). For example, see flowers
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) Default textures to be used for this block. The Dictionary keys are the texture short names, as referenced in this block's shape ShapeElementFaces
(may be null on clients, prior to receipt of server assets)
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) Fast array of texture variants, for use by cube (or similar) tesselators if the block has alternate shapes The outer array is indexed based on the 6 BlockFacing.Index numerals; the inner array is the variants Textures to be used for this block in the inventory GUI, held in hand or dropped on the ground
(may be null on clients, prior to receipt of server assets)
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) Returns the first textures in the TexturesInventory dictionary Defines which of the 6 block sides are completely opaque. Used to determine which block faces can be culled during tesselation. Defines which of the 6 block side are solid. Used to determine if attachable blocks can be attached to this block. Also used to determine if snow can rest on top of this block. Defines which of the 6 block side should be shaded with ambient occlusion Defines which of the 6 block neighbours should receive AO if this block is in front of them Defines what creature groups may spawn on this block Determines which sides of the blocks should be rendered The color map for climate color mapping. Leave null for no coloring by climate The color map for season color mapping. Leave null for no coloring by season Internal value that's set during if the block shape has any tint indexes for use in chunk tesselation and stuff O_O Three extra color / season bits which may have meaning for specific blocks, such as leaves Defines the area with which the player character collides with. Defines the area which the players mouse pointer collides with for selection. Defines the area with which particles collide with (if null, will be the same as CollisionBoxes). Used for ladders. If true, walking against this blocks collisionbox will make the player climb Will be used for not rendering rain below this block Value between 0..7 for Liquids to determine the height of the liquid If this block is or contains a liquid, this should be the code (or "identifier") of the liquid A flag set during texture block shape tesselation Modifiers that can alter the behavior of a block, particularly when being placed or removed Modifiers that can alter the behavior of a block entity The items that should drop from breaking this block If true, a blocks drops will be split into stacks of stacksize 1 for more game juice. This field is only used in OnBlockBroken() and OnBlockExploded() Information about the blocks as a crop If this block has a block entity attached to it, this will store it's code Entity pushing while an entity is inside this block. Read from attributes because i'm lazy. To allow Decor Behavior settings to be accessed through the Block API. See DecorFlags class for interpretation. Used to adjust selection box of parent block To tell the JsonTesselator the offset to use when checking whether this is being rendered in/on ice (Currently only implemented by BlockWaterLily, compare seaweed and other water plants which check whether the block they are inside is ice, so their IceCheckOffset has the default value of 0) Creates a new instance of a block with null model transforms; BlockTypeNet will add default transforms client-side if they are null in the BlockType packet; transforms should not be needed on a server Called when this block was loaded by the server or the client Sets the whole SideOpaque array to true Called for example when the player places a block inside a liquid block. Needs to return true if the liquid should get removed. Does the side APPEAR fully solid? Called for example when deciding to render water edges at a position, or not Note: Worldgen code uses the blockAccessor-aware overload of this method Is the side solid or almost fully solid (in the case of chiselled blocks)? Called for example when deciding to place loose stones or boulders above this during worldgen This method gets called when facecull mode is set to 'Callback'. Curently used for custom behaviors when merging ice The index of the BlockFacing face of this block being tested The neighbouring block The position index within the chunk (z * 32 * 32 + y * 32 + x): the BlockEntity can be obtained using this if necessary The cuboid used to determine where to spawn particles when breaking the block Returns the blocks selection boxes at this position in the world. Returns the blocks collision box. Warning: This method may get called by different threads, so it has to be thread safe. Returns the blocks particle collision box. Warning: This method may get called by different threads, so it has to be thread safe. Should return the blocks material Warning: This method is may get called in a background thread. Please make sure your code in here is thread safe. May be null and therfore stack is non-null Should return the blocks resistance to breaking Should returns the blocks sounds Position-aware version of Attributes, for example can be used by BlockMultiblock If this block is or contains a liquid, it should return the code of it. Used for example by farmland to check if a nearby block is water Called before a decal is created. The block model which need UV values for the decal texture The original block model Used by torches and other blocks to check if it can attach itself to that block Area of attachment of given face in voxel dimensions (0..15) Should return if supplied entitytype is allowed to spawn on this block Currently used for wildvines and saguaro cactus Called when the player attempts to place this block If you return false, set this value to a code why it cannot be placed. Its used for the ingame error overlay. Set to "__ignore__" to not trigger an error Checks if this block does not intersect with something at given position Called by TryPlaceBlock if placement is possible Might be null Called by the server and the client when the player currently looks at this block. Gets called continously every tick. True when previous tick the player looked at a different block. You can use it to make an efficient, single-event lookat trigger Player is breaking this block. Has to reduce remainingResistance by the amount of time it should be broken. This method is called only client side, every 40ms during breaking. The item the player currently has in his hands how many seconds was left until the block breaks fully seconds passed since last render frame Total count of hits (every 40ms) how many seconds now left until the block breaks fully. If a value equal to or below 0 is returned, OnBlockBroken() will get called. Called when a survival player has broken the block. This method needs to remove the block. Should return all of the blocks drops for display in the handbook Helper method for a number of blocks Is called before a block is broken, should return what items this block should drop. Return null or empty array for no drops. When the player has presed the middle mouse click on the block Always called when a block has been removed through whatever method, except during worldgen or via ExchangeBlock() For Worldgen you might be able to use TryPlaceBlockForWorldGen() to attach custom behaviors during placement/removal Always called when a block has been placed through whatever method, except during worldgen or via ExchangeBlock() Spawns the associated block entity, remember to call the base method! For Worldgen you might be able to use TryPlaceBlockForWorldGen() to attach custom behaviors during placement/removal May be null! Called when any of its 6 neighbour blocks has been changed When a player does a right click while targeting this placed block. Should return true if the event is handled, so that other events can occur, e.g. eating a held item if the block is not interactable with. False if the interaction should be stopped. True if the interaction should continue. If you return false, the interaction will not be synced to the server. When a Command Block, console command or (perhaps in future) non-player entity wants to activate this placed block Called every frame while the player is using this block. Return false to stop the interaction. Called when the player successfully completed the using action, always called once an interaction is over When the player released the right mouse button. Return false to deny the cancellation (= will keep using the block until OnBlockInteractStep returns false). When an entity is inside a block 1x1x1 space, independent of of its selection box or collision box Whenever an entity collides with the collision box of the block Called when a falling block falls onto this one. Return true to cancel default behavior.
Note: From game version 1.20.4, if overriding this you should also override (). See BlockCoalPile for an example. If CanAcceptFallOnto() is not implemented, then this OnFallOnto() method will most likely never be called Called on the main main thread or, potentially, on a separate thread if multiple physics threads is enabled. Return true to have () called, which will always be on the main thread Everytime the player moves by 8 blocks (or rather leaves the current 8-grid), a scan of all blocks 32x32x32 blocks around the player is initiated
and this method is called. If the method returns true, the block is registered to a client side game ticking for spawning particles and such.
This method will be called everytime the player left his current 8-grid area. If this block defines an ambient sounds, the intensity the ambient should be played at. Between 0 and 1. Return 0 to not play the ambient sound. Called evey 25ms if the block is in range (32 blocks) and block returned true on ShouldReceiveClientGameTicks(). Takes a few seconds for the game to register the block. Called every interval specified in Server.Config.RandomTickInterval. Defaults to 50ms. This method is called on a separate server thread. This should be considered when deciding how to access blocks. If true is returned, the server will call OnServerGameTick on the main thread passing the BlockPos and the 'extra' object if specified. The 'extra' parameter is meant to prevent duplicating lookups and other calculations when OnServerGameTick is called. The position of this block If you do anything with random inside this method, don't use world.Rand because its not thread safe, use this or create your own instance Optional parameter to set if you need to pass additional data to the OnServerGameTick method Called by the main server thread if and only if this block returned true in ShouldReceiveServerGameTicks. The position of this block The value set for the 'extra' parameter when ShouldReceiveGameTicks was called. If this block uses drawtype json, this method will be called everytime a chunk containing this block is tesselated. Emitted light from this block Optional, fast way to look up a direct neighbouring block. This is an array of the current chunk blocks, also including all direct neighbours, so it's a 34 x 34 x 34 block list. extIndex3d is the index of the current Block in this array. Use extIndex3d+TileSideEnum.MoveIndex[tileSide] to move around in the array. See description of chunkExtBlocks Used as base position for particles. Used to determine if a block should be treated like air when placing blocks. (e.g. used for tallgrass) Returns a horizontal and vertical orientation which should be used for oriented blocks like stairs during placement. Called in the servers main thread The block as returned by your GetSnowLevelUpdateBlock() method Should return the snow covered block code for given snow level. Return null if snow cover is not supported for this block. If not overridden, it will check if Variant["cover"] exists and return its snow covered variant. Return a positive integer if the block retains heat (for warm rooms or greenhouses) or a negative integer if it preserves cool (for cellars) Return a positive integer if the block retains something, e.g. (for warm rooms or greenhouses) or a negative integer if something can pass through, e.g. cool for cellars The cost of traversing this block as part of the AI pathfinding system. Return a negative value to prefer traversal of a block, return a positive value to avoid traversal of this block. A value over 10000f is considered impassable. Default value is 0 For any block that can be rotated, this method should be implemented to return the correct rotated block code. It is used by the world edit tool for allowing block data rotations For any block that can be flipped upside down, this method should be implemented to return the correctly flipped block code. It is used by the world edit tool for allowing block data rotations For any block that can be flipped vertically, this method should be implemented to return the correctly flipped block code. It is used by the world edit tool for allowing block data rotations Returns the blocks behavior of given type, if it has such behavior Called by the block info HUD for display the interaction help besides the crosshair Called by the block info HUD for displaying the blocks name Called by the block info HUD for displaying additional information Called by the inventory system when you hover over an item stack. This is the text that is getting displayed. Opportunity for blocks to add additional lines to the Held Item info _prior to_ the behaviors output (such as nutrition properties or block reinforcement) If true, the player can select invdividual selection boxes of this block Called by the texture atlas manager when building up the block atlas. Has to add all of the blocks texture Should return the blocks blast resistance. Default behavior is to return BlockMaterialUtil.MaterialBlastResistance(blastType, BlockMaterial); Should return the chance of the block dropping its upon upon being exploded. Default behavior is to return BlockMaterialUtil.MaterialBlastDropChances(blastType, BlockMaterial); Called when the block was blown up by explosives Should return the color to be used for the block particle coloring Should return a random pixel within the items/blocks texture Should return an RGB color for this block. Current use: In the world map. Default behavior: The 2 averaged pixels at 40%/40% ad 60%/60% position Tint less version of GetColor. Used for map color export Alias of api.World.BlockAccessor.GetBlockEntity(blockSel.Position) as T Alias of api.World.BlockAccessor.GetBlockEntity(position) as T Alias of api.World.BlockAccessor.GetBlockEntity(pos)?.GetBehavior<T>() Returns instance of class that implements this interface in the following order
1. Block (returns itself)
2. BlockBehavior (returns on of our own behavior)
3. BlockEntity
4. BlockEntityBehavior Creates a deep copy of the block Returns true if the block has given block behavior Returns true if the block has given block behavior OR collectible behavior Return a decimal between 0.0 and 1.0 indicating - if this block is solid enough to block liquid flow on that side - how high the barrier is Simple string representation for debugging Allows for definitions of behaviors of a block that can be applied to any block See the derived types for a list of all documented block behaviors. The block for this behavior instance. Called when a survival player has broken the block. The default behavior removes the block and spawns the block drops. When the player has presed the middle mouse click on the block. The default behavior returns an itemstack with the block itself Is called before a block is broken, should return what items this block should drop. Return null or empty array for no drops. The default behavior drops whatever block.Drops is set to. Called when any of it's 6 neighbour blocks has been changed Used by torches and other blocks to check if it can attach itself to that block. The default behavior tests for SideSolid[blockFace.Index] Should return if supplied entitytype is allowed to spawn on this block For any block that can be rotated, this method should be implemented to return the correct rotated block code. It is used by the world edit tool for allowing block data rotations For any block that can be flipped upside down, this method should be implemented to return the correctly flipped block code. It is used by the world edit tool for allowing block data rotations For any block that can be flipped vertically, this method should be implemented to return the correctly flipped block code. It is used by the world edit tool for allowing block data rotations Used to determine if a block should be treated like air when placing blocks. (e.g. used for tallgrass) Everytime the player moves by 8 blocks (or rather leaves the current 8-grid), a scan of all blocks 32x32x32 blocks around the player is initiated and this method is called. If the method returns true, the block is registered to a client side game ticking for spawning particles and such. This method will be called everytime the player left his current 8-grid area. The default behavior is to return true if block.ParticleProperties are set Always called when a block has been removed through whatever method, except during worldgen or via ExchangeBlock() For Worldgen you might be able to use TryPlaceBlockForWorldGen() to attach custom behaviors during placement/removal The default behavior is to delete the block entity, if this block has any When a player does a right click while targeting this placed block. Should return true if the event is handled, so that other events can occur, e.g. eating a held item if the block is not interactable with. Called by the block info HUD for displaying additional information Step 1: Called when the player attempts to place this block. The default behavior calls Block.DoPlaceBlock(). If returned true and default behavior has not been prevented, the game will next call CanPlaceBlock(). If that method also returns true and default behavior has not been overriden, DoPlaceBlock() will get called. Step 2: Test if the block can be placed Step 3: Place the block. Return false if it cannot be placed (but you should rather return false in CanPlaceBlock). Step 4: Block was placed. Always called when a block has been placed through whatever method, except during worldgen or via ExchangeBlock() Until 1.20: The BlockEntity (if the block has one) does not exist yet at this point and will not be generated if handling is not PassThrough 1.21+: The BlockEntity (if the block has one) exists at this point. Setting handling to PreventDefault or PreventSubsequent has no effect on BlockEntity creation, but may affect/prevent later behaviors If this is less than 1.0, will slow down mining of the given block (e.g. used for reinforced blocks) Represents an itemstack that is dropped when breaking a block, with a potentially random quantity. "drops": [ { "type": "item", "code": "bone", "quantity": { "avg": 4, "var": 2 } } ] Block or Item? Code of the block or item Quantity to be dropped Tree Attributes that should be attached to the resulting itemstack If true, and this drop occurs, no further drops will happen. If set, then the given tool is required to make this block drop anything. The resulting ItemStack for this block being broken by a tool. If set, the drop quantity will be modified by the collecting entity stat code - entity.Stats.GetBlended(code). Sets itemstack.block or itemstack.item Returns an itemstack with random quantity as configured via the Quantity field Creates a deep copy of this object Reads the contents of the block bytes and converts it into a block. The reader of the block The block registry The save data writer. The writer to write blocks to. Basic class for block entities - a data structures to hold custom information for blocks, e.g. for chests to hold it's contents The core API added to the block. Accessable after initialization. Position of the block for this block entity The block type at the position of the block entity. This poperty is updated by the engine if ExchangeBlock is called List of block entity behaviors associated with this block entity Creats an empty instance. Use initialize to initialize it with the api. This method is called right after the block entity was spawned or right after it was loaded from a newly loaded chunk. You do have access to the world and its blocks at this point. However if this block entity already existed then FromTreeAttributes is called first! You should still call the base method to sets the this.api field Registers a game tick listener that does the disposing for you when the Block is removed Removes a registered game tick listener from the game. the ID of the listener to unregister. Registers a delayed callback that does the disposing for you when the Block is removed Unregisters a callback. This is usually done automatically. The ID of the callback listiner. Called when the block at this position was removed in some way. Removes the game tick listeners, so still call the base method Called when blockAccessor.ExchangeBlock() is used to exchange this block. Make sure to call the base method when overriding. Called when the block was broken in survival mode or through explosions and similar. Generally in situations where you probably want to drop the block entity contents, if it has any Called by the undo/redo system, after calling FromTreeAttributes Called when the chunk the block entity resides in was unloaded. Removes the game tick listeners, so still call the base method Called when the block entity just got placed, not called when it was previously placed and the chunk is loaded. Always called after Initialize() Called when saving the world or when sending the block entity data to the client. When overriding, make sure to still call the base method. Called when loading the world or when receiving block entity from the server. When overriding, make sure to still call the base method. FromTreeAttributes is always called before Initialize() is called, so the this.api field is not yet set! Use this api if you need to resolve blocks/items. Not suggested for other purposes, as the residing chunk may not be loaded at this point Called whenever a blockentity packet at the blocks position has been received from the client Called whenever a blockentity packet at the blocks position has been received from the server When called on Server: Will resync the block entity with all its TreeAttribute to the client, but will not resend or redraw the block unless specified. When called on Client: Triggers a block changed event on the client, but will not redraw the block unless specified. When true, the block is also marked dirty and thus redrawn. When called serverside a dirty block packet is sent to the client for it to be redrawn Called by the block info HUD for displaying additional information Called by the worldedit schematic exporter so that it can also export the mappings of items/blocks stored inside blockentities Called by the blockschematic loader so that you may fix any blockid/itemid mappings against the mapping of the savegame, if you store any collectibles in this blockentity. Note: Some vanilla blocks resolve randomized contents in this method. Hint: Use itemstack.FixMapping() to do the job for you. If you need some sort of randomness consistency accross an imported schematic, you can use this value Called by the blockschematic loader so that you may fix any blockid/itemid mappings against the mapping of the savegame, if you store any collectibles in this blockentity. Note: Some vanilla blocks resolve randomized contents in this method. Hint: Use itemstack.FixMapping() to do the job for you. If you need some sort of randomness consistency accross an imported schematic, you can use this value Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn Let's you add your own meshes to a chunk. Don't reuse the meshdata instance anywhere in your code. Return true to skip the default mesh. WARNING! The Tesselator runs in a seperate thread, so you have to make sure the fields and methods you access inside this method are thread safe. The chunk mesh, add your stuff here If you need to tesselate something, you should use this tesselator, since using the main thread tesselator can cause race conditions and crash the game True to skip default mesh, false to also add the default mesh Called when this block entity was placed by a schematic, either through world edit or by worldgen If block.CustomBlockLayerHandler is true and the block is below the surface, this value is set Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn Allows adding behaviors for block entities. Remember, block entities are specific instances of blocks placed within the world. "entityClass": "Brake", "entityBehaviors": [ { "name": "MPBrake" }, { "name": "Animatable" } ], The ID for this block entity behavior. A set of properties specific to the block entity behavior class. Basic class for block entities - a data structures to hold custom information for blocks, e.g. for chests to hold it's contents The block for this behavior instance. Alias of Blockentity.Pos Alias of BlockEntity.Block The properties of this block behavior. Called right after the block behavior was created Height distribution for plants inside the coral reef chance for this plant to spawn in a reef if List of asset codes for the base (coralblock) types of a coral reef blockpatch List of asset codes for the coral structure types of a coral reef blockpatch List of asset codes for the coral shelved types of a coral reef blockpatch These need to have HorizontalOrientable behaviour and only specify one side in here "coralshelf-north" List of asset codes for the coral decor of a coral reef blockpatch These will be placed on solid surfaces around coral base blocks and on top of structures List of asset codes for the coral types of a coral reef blockpatch coral-brain, coral-fan ... Defines the minimum 2D size of the coral reef Defines the random size between 0 - X that will be added additionally to the reef Chance for a shelf block to spawn on a under water cliff. The chance is rolled for each height The patch will try to spawn them until it reaches minWaterDepth Chance that any Plant will spawn Specifiy which plants should spawn for this blockpatch and their heigh and how often a specific plant should be chosen Chance that a shelf will spawn instead of a structure on top of a coralblock Chance that coral generating will replace all other block patches in its area If no shelf was spawned this chance controls how likely a structure will spawn instead of a coral. If a structure is spawned then a coral will spawn on top If no shelve nor structure was spawned then also a coral will be spawned When a coral [brain, fan] gets spawned also try if a decor should spawn below it Also on vertical growth we try to spawn decors cliffs Chance to spawn a coral [brain, fan] on top of base blocks or structures How thick the base coral full block layer should be for this patch (goes down into the ground, helpful for cliffs) 1 -> replace the gravel with coral 2 -> go 1 block below gravel and also replace and so on Chance that a BlockCrowfoot will spawn a flower when it reaches the water surface Heigh distribution for BlockSeaweed and BlockCrowfoot types Replace if new block replaceable value > old block replaceable value Replace always, no matter what blocks were there previously Replace always, no matter what blocks were there previously, but skip air blocks in the schematic Replace only air blocks Distance positions from bottom left corner of the schematic. Only the first door block. Distance from the bottom left door block, so the bottom left door block is always at 0,0,0 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 Set by the RemapperAssistant in OnFinalizeAssets This bitmask for the position in schematics Construct a schematic from a specified area in the specified world Loads the meta information for each block in the schematic. Adds an area to the schematic. The world the blocks are in The start position of all the blocks. The end position of all the blocks. 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() 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() Attempts to transform each block as they are placed in directions different from the schematic. Places all the entities and blocks in the schematic at the position. Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn Gets just the positions of the blocks. The origin point to start from An array containing the BlockPos of each block in the area. Gets the starting position of the schematic. Adjusts the starting position of the schemtic. Loads the schematic from a file. Loads a schematic from a string. Saves a schematic to a file. Exports the block entity data to a string. Exports the tree attribute data to a string. Imports the tree data from a string. Makes a deep copy of the packed schematic. Unpacked data and loaded meta information is not cloned. Contains all the information for a players block selection event The position the player wants to place/break something at The face the player aimed at The coordinate of the exact aimed position, relative to the Block Position Which selection box was aimed at. The index corresponds to the array returned by Block.GetSelectionBoxes() Always false during block use. True during placement if the Position value was offseted. Example: - When trying to place planks while aiming at rock, the Position is the one in front of the Rock and DidOffset is True - When trying to place planks while aiming at tallgrass, the Position is where the tall grass is and DidOffset is false (because tallgrass is replacable) The block actually being looked at! Creates a basic BlockSelection from limited data Creates a deep copy Returns a subposition index for use addressing decor subpositions on a block A set of sounds that are defined for a block. All fields use default or empty sounds if not set. "sounds": { "place": "block/dirt", "break": "block/dirt", "hit": "block/dirt", "walk": "walk/grass" }, Played when an entity walks on this block. Played when an entity moves inside this block. Primarily used for liquids. Played when this block is broken. Played when this block is placed. Played when this block is hit. Will be overridden by if an appropriate tool is set. Played in ambience for this block. The type of sound for this block's ambient sound. Adjacent ambient sound sources are merged to avoid playing too many sounds too loudly. This is the maximum distance a sound source can be from another to allow a merge. Amount of nearby ambient sound blocks in order to reach full ambient sound volume Gets the sound that occurs when a specific tool hits a block. (Note for coders: if none specified in the JSON, this will be null from version 1.20.4 onwards) Clones the block sounds. Gets the breaking sound, either provided by the tool or by this sound. Gets the hit sound either provided by the tool or by the block. Gets the break sound either by the tool or by the block if the tool does not have a break sound. The Tool used. The resulting sound Gets the hit sound either by the tool or by the block if the tool does not have a hit sound. The three types of soil nutrient for farmland and crops. Which nutrient category this crop requires to grow Total amount of nutrient consumed to reach full maturity. (100 is the maximum available for farmland) Amount of growth stages this crop has Total time in ingame days required for the crop to reach full maturity assuming full nutrient levels Total time in ingame months required for the crop to reach full maturity assuming full nutrient levels If true, the player may harvests from the crop multiple times When multiple harvets is true, this is the amount of growth stages the crop should go back when harvested Allows customization of crop growth behavior. BlockEntityFarmland calls methods on all behaviors to allow greater control. Initializes the crop with additional properties. Attempts to grow the crop. The Core API The farmland below the crop. The next growth stage. Whether or not this event was handled. Whether or not the crop grew. The event fired when the crop is planted. The core API. The itemslot that the plant was planted with. The entity that planted the plant. The block selection used when the seed was planted. Total game hours from where on it can enter the next growth stage The last time fertility increase was checked Farmland has 3 nutrient levels N, P and K located in this array in that order. Each nutrient level has a range of 0-100. The farmlands moisture level The fertility the soil will recover to (the soil from which the farmland was made of) The position of the farmland The position directly above the farmland An actual instance of this struct is the 'faceAndSubposition' data.
The struct also provides various static methods to convert elements to and from a PackedIndex used in WorldChunk storage Simplest case, we supply just a face (no subposition for cave-art, and no rotation) Turn both face and local voxel position to a decor faceAndSubposition index 0..15 0..15 0..15 A bit mask to select bits 0-14, i.e. the chunk's index3d A bit mask to select the three most significant bits of a byte, 0b11100000 or 0xE0 A bit mask to select the five least significant bits of a byte, 0b00011111 or 0x1F A bit mask to select the three rotation data bits; this is also the maxvalue of the rotationData The packedIndex works like this: [radfast 7 Dec 2024, 1.20-rc.2] The packedIndex has four components: index3d for the block's local x,y,z value within the chunk, each in the range 0-31, for 15 bits in total faceindex for the face of the block this decor is on (corresponding to BlockFacing.Index), range 0-5 optionally, a subposition in the range 0-256, where 0 means no subposition, and values 1-256 give a subposition in the 16x16 subgrid, used for ArtPigment or similar optionally, 3 bits of rotation data These are packed into bits in the following way, it has to be this way for backwards compatibility reasons (assuming we do not want to add a new chunk dataversion) 31 - 24 (the five Least Significant Bits of the subposition) * 6 + faceindex 23 - 21 (the three Most Significant Bits of the subposition) 20 - 19 (unused) 18 - 16 rotation data 15 (unused) 14 - 0 index3d (Exceptionally, the value in bits 31-24 has the magic value of (0x20 * 6 + faceindex), and the value in bits 23-16 is 0xE0, if a subposition value of 256 is intended: this works within the existing algorithms because 0xE0 + 0x20 == 0x100 i.e. 256. If necessary we can have values up to 0x2A there, so the range of possible subpositions is up to 266) 0000 0000 0000 0000 0000 0000 0000 0000 Materials of which a block may be made of. Currently only used for mining speed for tools and blast resistance. Calculates the blast resistance of a given material. The blast type the material is being it with. The material of the block. the resulting blast resistance. Calculates the blast drop chance of a given material. The blast type the material is being it with. The material of the block. the resulting drop chance. Various states of matter to use for collectibles. The state of being so thin that molecules don't often touch The state of being still together but loose enough to move around each other. The state of being together and held still by the internal structure. The state of reacting with itself with some kind of reactant, a high heat state. The state of becoming Quantum Jelly. Used for blocks (e.g. crops and dead crops) where the y-position might need to be adjusted at the time of tesselating an individual block Used for blocks (e.g. chiselled blocks) where the basic block geometry: AO shading, side opaque etc - depends on the individual block or blockEntity Implement this interface if schematics containing this block entity needs to modify it's tree attribute data. Beware, this method is called without the block entity existing in the world (yet). The modified tree will then be used to actually create the block If flipAxis is null it means it was not flipped, only horizontally rotated. Apply flip first, and then rotation. Used for rotation of schematics, so microblocks can update their materials Used for blocks (e.g. tallgrass and flowers) where the drawnHeight is set in attributes Measured in texture pixels based on our standard pixel density for 32x32 textures. So a value of 32 would be one block high; the typical value of 48 is the full height of tallgrass or a flowerTall because those use 48x48 pixel textures Same as block behavior but allows even more control over a block, such as the blocks collision boxes and world gen behavior. These are not part of default block behaviors for performance reasons. Requires the block to use the GenericBlock block class (or inherit from it) On the graphics card we have only one reflective bit, but we can store the mode in the wind data bits Not reflective Sun-Position independent reflectivity Sun-Position dependent weak reflectivity Sun-Position dependent weak reflectivity Many small sparkles Not affected by wind Slightly affected by wind. Wiggle + Height bend based on ground distance. Normally affected by wind. Wiggle + Height bend based on ground distance. Same as normal wind, but with some special behavior for leaves. Wiggle + Height bend based on ground distance. Same as normal wind, but no wiggle. Weak height bend based on ground distance. Bend behavior for tall plants Vertical wiggle Windmode flags, which can be ORed with existing vertex data to add the specified wind mode (assuming it was 0 previously!) Slightly affected by wind. Wiggle + Height bend based on ground distance.
 Normally affected by wind. Wiggle + Height bend based on ground distance. Same as normal wind, but with some special behavior for leaves. Wiggle + Height bend based on ground distance. Same as weak wind, but no wiggle. Height bend based on ground distance. Bend behavior for tall plants Vertical wiggle Vertical wiggle Special class to handle the vertex flagging in a very nicely compressed space.
Bit 0-7: Glow level
Bit 8-10: Z-Offset
Bit 11: Reflective bit
Bit 12: Lod 0 Bit
Bit 13-24: X/Y/Z Normals
Bit 25, 26, 27, 28: Wind mode
Bit 29, 30, 31: Wind data (also sometimes used for other data, e.g. reflection mode if Reflective bit is set, or additional water surface data if this is a water block)
 "vertexFlagsByType": { "metalblock-new-*": { "reflective": true, "windDataByType": { "*-gold": 1, "*": 1 } } }, Bit 0..7 Bit 8..10 Bit 11. Note if this is set to 1, then WindData has a different meaning, Bit 12 Bit 13..24 Bit 25..28 Bit 29..31 Note that WindData is sometimes used for other purposes if WindMode == 0, for example it can hold reflections data, see EnumReflectiveMode.
Also worth noting that WindMode and WindData have totally different meanings for liquid water Bit 26..31 Important: DO NOT USE THIS WITH THE << OPERATOR: it's already shifted. It is a bit mask not a bit pos! Important: DO NOT USE THIS WITH THE << OPERATOR: it's already shifted. It is a bit mask not a bit pos! Important: DO NOT USE THIS WITH THE << OPERATOR: it's already shifted. It is a bit mask not a bit pos! Important: DO NOT USE THIS WITH THE << OPERATOR: it's already shifted. It is a bit mask not a bit pos! Important: DO NOT USE THIS WITH THE << OPERATOR: it's already shifted. It is a bit mask not a bit pos! Sets all the vertex flags from one integer. Creates an already bit shifted normal Creates an already bit shifted normal Creates an already bit shifted normal Creates an already bit shifted normal Clones this set of vertex flags. Contains all properties shared by Blocks and Items Liquids are handled and rendered differently than solid blocks. This value is set the the BlockId or ItemId-Remapper if it encounters a block/item in the savegame, but no longer exists as a loaded block/item The block or item id For blocks and items, the hashcode is the id - useful when building HashSets Block or Item? Max amount of collectible that one default inventory slot can hold How many uses does this collectible has when being used. Item disappears at durability 0 Physical size of this collectible when held or (notionally) in a container. 0.5 x 0.5 x 0.5 meters by default.
Note, if all three dimensions are set to zero, the default will be used. When true, liquids become selectable to the player when being held in hands How much damage this collectible deals when used as a weapon If true, when the player holds the sneak key and right clicks with this item in hand, calls OnHeldInteractStart first. Without it, the order is reversed. Takes precedence over priority interact placed blocks. Until how for away can you attack entities using this collectibe From which damage sources does the item takes durability damage Modifies how fast the player can break a block when holding this item What tier this block can mine when held in hands List of creative tabs in which this collectible should appear in If you want to add itemstacks with custom attributes to the creative inventory, add them to this list Alpha test value for rendering in gui, fp hand, tp hand or on the ground Used for scaling, rotation or offseting the block when rendered in guis Used for scaling, rotation or offseting the block when rendered in the first person mode hand Used for scaling, rotation or offseting the block when rendered in the third person mode hand Used for scaling, rotation or offseting the block when rendered in the third person mode offhand Used for scaling, rotation or offseting the rendered as a dropped item on the ground Custom Attributes that's always assiociated with this item Information about the burnable states Information about the nutrition states Information about the transitionable states If set, the collectible can be ground into something else If set, the collectible can be crushed into something else Particles that should spawn in regular intervals from this block or item when held in hands The origin point from which particles are being spawned If set, this item will be classified as given tool Determines in which kind of bags the item can be stored in Determines on whether an object floats on liquids or not. Water has a density of 1000 The animation to play in 3rd person mod when hitting with this collectible The animation to play in 3rd person mod when holding this collectible in the right hand The animation to play in 3rd person mod when holding this collectible in the left hand The animation to play in 3rd person mod when using this collectible The api object, assigned during OnLoaded Modifiers that can alter the behavior of the item or block, mostly for held interaction For light emitting collectibles: hue, saturation and brightness value Server Side: Called one the collectible has been registered Client Side: Called once the collectible has been loaded from server packet Called when the client/server is shutting down Should return the light HSV values. Warning: This method is likely to get called in a background thread. Please make sure your code in here is thread safe. May be null Set if its an itemstack for which the engine wants to check the light level Should return the nutrition properties of the item/block Should return the transition properties of the item/block when in itemstack form Should returns true if this collectible requires UpdateAndGetTransitionStates() to be called when ticking.
Typical usage: true if this collectible itself has transitionable properties, or true for collectibles which hold other itemstacks with transitionable properties (for example, a cooked food container) Should return in which storage containers this item can be placed in Returns a hardcoded rgb color (green->yellow->red) that is representative for its remaining durability vs total durability Return true if remaining durability != total durability This method is called before rendering the item stack into GUI, first person hand, third person hand and/or on the ground The renderinfo object is pre-filled with default values. Returns the items total durability The amount of damage dealt when used as a weapon The the attack range when used as a weapon Player is holding this collectible and breaks the targeted block Whenever the collectible was modified while inside a slot, usually when it was moved, split or merged. The slot the item is or was in Non null if the itemstack was removed from this slot Player has broken a block while holding this collectible. Return false if you want to cancel the block break event. Called every game tick when the player breaks a block with this item in his hands. Returns the mining speed for given block. Not implemented yet Called when an entity uses this item to hit something in 3rd person mode Called when an entity holds this item in hands in 3rd person mode Called when an entity holds this item in hands in 3rd person mode Called when an entity holds this item in hands in 3rd person mode An entity used this collectibe to attack something Called when this collectible is attempted to being used as part of a crafting recipe and should get consumed now. Return false if it doesn't match the ingredient Called when this collectible is being used as part of a crafting recipe and should get consumed now Called when a matching grid recipe has been found and an item is placed into the crafting output slot (which is still before the player clicks on the output slot to actually craft the item and consume the ingredients) Called after the player has taken out the item from the output slot true to prevent default ingredient consumption Sets the items durability Causes the item to be damaged. Will play a breaking sound and removes the itemstack if no more durability is left Amount of damage Should return the current items tool mode. The tool mode to display or -1 to not display the current mode Should set given toolmode This method is called during the opaque render pass when this item or block is being held in hands This method is called during the order independent transparency render pass when this item or block is being held in hands This method is called during the ortho (for 2D GUIs) render pass when this item or block is being held in hands Called every frame when the player is holding this collectible in his hands. Is not called during OnUsing() or OnAttacking() Called every game tick when this collectible is in dropped form in the world (i.e. as EntityItem) Called every frame when this item is being displayed in the gui Called when this item was collected by an entity General begin use access. Override OnHeldAttackStart or OnHeldInteractStart to alter the behavior. True on first mouse down Whether or not to do any subsequent actions. If not set or set to NotHandled, the action will not called on the server. General cancel use access. Override OnHeldAttackCancel or OnHeldInteractCancel to alter the behavior. General using access. Override OnHeldAttackStep or OnHeldInteractStep to alter the behavior. General use over access. Override OnHeldAttackStop or OnHeldInteractStop to alter the behavior. When the player has begun using this item for attacking (left mouse click). Return true to play a custom action. Whether or not to do any subsequent actions. If not set or set to NotHandled, the action will not called on the server. When the player has canceled a custom attack action. Return false to deny action cancellation. Called continously when a custom attack action is playing. Return false to stop the action. Called when a custom attack action is finished Called when the player right clicks while holding this block/item in his hands True when the player pressed the right mouse button on this block. Every subsequent call, while the player holds right mouse down will be false, it gets called every second while right mouse is down Whether or not to do any subsequent actions. If not set or set to NotHandled, the action will not called on the server. Called every frame while the player is using this collectible. Return false to stop the interaction. False if the interaction should be stopped. True if the interaction should continue Called when the player successfully completed the using action, always called once an interaction is over When the player released the right mouse button. Return false to deny the cancellation (= will keep using the item until OnHeldInteractStep returns false). Tries to eat the contents in the slot, first call Tries to eat the contents in the slot, eat step call Finished eating the contents in the slot, final call Callback when the player dropped this item from his inventory. You can set handling to PreventDefault to prevent dropping this item. You can also check if the entityplayer of this player is dead to check if dropping of this item was due the players death Amount of items the player wants to drop Called by the inventory system when you hover over an item stack. This is the item stack name that is getting displayed. Called by the inventory system when you hover over an item stack. This is the text that is getting displayed. Interaction help thats displayed above the hotbar, when the player puts this item/block in his active hand slot Should return true if the stack can be placed into given slot Should return the max. number of items that can be placed from sourceStack into the sinkStack Is always called on the sink slots item If the item is smeltable, this is the time it takes to smelt at smelting point If the item is smeltable, this is its melting point Should return true if this collectible is smeltable in an open fire Transform the item to it's smelted variant Returns true if the stack can spoil Returns the transition state of given transition type Returns a list of the current transition states of this item, redirects to UpdateAndGetTransitionStatesNative Returns a list of the current transition states of this item. Seperate from UpdateAndGetTransitionStates() so that you can call still call this methods several inheritances down, i.e. there is no base.base.Method() syntax in C# Called when any of its TransitionableProperties causes the stack to transition to another stack. Default behavior is to return props.TransitionedStack.ResolvedItemstack and set the stack size according to the transition rtio The stack it should transition into Test is failed for Perish-able items which have less than 50% of their fresh state remaining (or are already starting to spoil) Returns true if the stack has a temperature attribute Returns the stacks item temperature in degree celsius The amount of time it did receive heat since last update/call to this methode Returns the stacks item temperature in degree celsius Sets the stacks item temperature in degree celsius Should return true if given stacks are equal, ignoring their stack size. Should return true if thisStack is a satisfactory replacement of otherStack. It's bascially an Equals() test, but it ignores any additional attributes that exist in otherStack This method is for example called by chests when they are being exported as part of a block schematic. Has to store all the currents block/item id mappings so it can be correctly imported again. By default it puts itself into the mapping and searches the itemstack attributes for attributes of type ItemStackAttribute and adds those to the mapping as well. This method is called after a block/item like this has been imported as part of a block schematic. Has to restore fix the block/item id mappings as they are probably different compared to the world from where they were exported. By default iterates over all the itemstacks attributes and searches for attribute sof type ItenStackAttribute and calls .FixMapping() on them. This method is called after a block/item like this has been imported as part of a block schematic. Has to restore fix the block/item id mappings as they are probably different compared to the world from where they were exported. By default iterates over all the itemstacks attributes and searches for attribute sof type ItenStackAttribute and calls .FixMapping() on them. Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn Should return a random pixel within the items/blocks texture Returns true if this blocks matterstate is liquid. (Liquid blocks should also implement IBlockFlowing)
IMPORTANT: Calling code should have looked up the block using IBlockAccessor.GetBlock(pos, BlockLayersAccess.Fluid) Returns the blocks behavior of given type, if it has such behavior Returns instance of class that implements this interface in the following order
1. Collectible (returns itself)
2. CollectibleBlockBehavior (returns on of our own behavior)
 Returns true if the block has given behavior Returns true if the block has given behavior Returns true if the block has given behavior Returns the blocks behavior of given type, if it has such behavior Returns the blocks behavior of given type, if it has such behavior Called immediately prior to a firepit or similar testing whether this Collectible can be smelted
Returns true if the caller should be marked dirty A behavior object which can be added to any collectible. See the derived types for a list of documented collectible behaviors. The collectible object (item or block) for this behavior instance. The properties of this block behavior. If true, this behavior is not required on the client. This is here because copygirl doesn't stop asking for it. Probably breaks things. If it breaks things, complain to copygirl please :p Called right after the block behavior was created, must call base method Server Side: Called once the collectible has been registered Client Side: Called once the collectible has been loaded from server packet When the player has begun using this item for attacking (left mouse click). Return true to play a custom action. When the player has canceled a custom attack action. Return false to deny action cancellation. Called continously when a custom attack action is playing. Return false to stop the action. Called when a custom attack action is finished Called when the player right clicks while holding this block/item in his hands Whether or not to do any subsequent actions. If not set or set to NotHandled, the action will not called on the server. Set to PreventDefault to not try eating the item, set to PreventSubsequent to ignore any subsequent calls to OnHeldInteractStart() of other behaviors Called every frame while the player is using this collectible Called when the player successfully completed the using action, not called when successfully cancelled When the player released the right mouse button. Return false to deny the cancellation (= will keep using the item until OnHeldInteractStep returns false). Called when the collectible is rendered in hands, inventory or on the ground Interaction help that is shown when selecting the item in the hotbar slot Called when the tool mode (F) key is pressed to generate the GUI Should return the current items tool mode. Should set given toolmode Player has broken a block while holding this collectible. Return false if you want to cancel the block break event. Player is holding this collectible and breaks the targeted block Multiplies resulted mining speed of the item by return value if 'bhHandling' is not equal to 'PassThrough'. If 'bhHandling' is not set to 'PreventDefault', the mining speed will be multiplied by standard item mining speed. Mining speed multiplier Adds return value to resulted durability if 'bhHandling' is not equal to 'PassThrough'. If 'bhHandling' is not set to 'PreventDefault', standard item durability will be added to result. Additional durability Adds return value to resulted durability if 'bhHandling' is not equal to 'PassThrough'. If 'bhHandling' is not set to 'PreventDefault', standard item durability will be added to result. Additional durability Called when item is damaged via 'CollectibleObject.DamageItem' Called when item durability is set via 'CollectibleObject.SetDurability' Called when any of its TransitionableProperties causes the stack to transition to another stack. Default behavior is to return props.TransitionedStack.ResolvedItemstack and set the stack size according to the transition rtio The stack it should transition into The type of smelting for the collectible. This effects how the object is smelted. Currently has no special behavior. Currently has no special behavior. This collectible must be baked in a clay oven. Note that you will likely want to use in the item's attributes. Currently has no special behavior. This collectible must be fired in a kiln. Marks an item as combustible, either by cooking, smelting or firing. This can either imply it is used as a fuel, or can be cooked into another object. Cooking: "combustiblePropsByType": { "bushmeat-raw": { "meltingPoint": 150, "meltingDuration": 30, "smeltedRatio": 1, "smeltingType": "cook", "smeltedStack": { "type": "item", "code": "bushmeat-cooked" }, "requiresContainer": false } }, Clay Firing: "combustiblePropsByType": { "bowl-raw": { "meltingPoint": 650, "meltingDuration": 45, "smeltedRatio": 1, "smeltingType": "fire", "smeltedStack": { "type": "block", "code": "bowl-fired" }, "requiresContainer": false } }, Fuel Source: "combustibleProps": { "burnTemperature": 1300, "burnDuration": 40 }, The temperature at which this collectible burns when used as a fuel. The duration, in real life seconds, that this collectible burns for when used as a fuel. How many degrees celsius it can resists before it ignites How many degrees celsius it takes to smelt/transform this collectible into another. Required if is set. If there is a melting point, the max temperature it can reach. A value of 0 implies no limit. For how many seconds the temperature has to be above the melting point until the item is smelted. Recommended if is set. How much smoke this item produces when being used as fuel How many of this collectible are needed to smelt into . Some smelt types have specific functionality, and are also used for correct naming in the tool tip. If using , you will need to include in your item attributes. If set, this is the resulting itemstack once the MeltingPoint has been reached for the supplied duration. If true, a container is required to smelt this item. Creates a deep copy Baking Properties are collectible attribute used for baking items in a clay oven. You will need to add these attributes if using inside . Example taken from bread. Note that the levelTo value in the baking stage is the same as the levelFrom in the next baking stage. "attributesByType": { "*-partbaked": { "bakingProperties": { "temp": 160, "levelFrom": 0.25, "levelTo": 0.5, "startScaleY": 0.95, "endScaleY": 1.10, "resultCode": "bread-{type}-perfect", "initialCode": "dough-{type}" } }, "*-perfect": { "bakingProperties": { "temp": 160, "levelFrom": 0.5, "levelTo": 0.75, "startScaleY": 1.10, "endScaleY": 1.13, "resultCode": "bread-{type}-charred", "initialCode": "bread-{type}-partbaked" } }, "*-charred": { "bakingProperties": { "temp": 160, "levelFrom": 0.75, "levelTo": 1, "startScaleY": 1.13, "endScaleY": 1.10, "initialCode": "bread-{type}-perfect" } } }, The temperature required to bake the item. The initial value, from 0 to 1, that determines how cooked the item is. When cooking an object with numerous cooking stages, these stages can be stacked using these values. Simply set the second stage's to the first stages . The final value, from 0 to 1, that determines how cooked the item is. When the cooking value reaches this value, the collectible will change into the next item. When cooking an object with numerous cooking stages, these stages can be stacked using these values. Simply set the second stage's to the first stages . The Y scale of this collectible when it begins cooking. Value will be linearly interpolated between this and . The Y scale of this collectible when it has finished cooking. Value will be linearly interpolated between and this. The code of the resulting collectible when this item finishes its cooking stage. The code of the initial collectible that is being baked. If true, only one instance of this collectible can be baked at a time. If false, 4 of this collectible can be baked at a time. Allows you to add a list of item stacks to put various into creative menu tabs. "creativeinventoryStacksByType": { "*-fired": [ { "tabs": [ "general", "decorative" ], "stacks": [ { "type": "block", "code": "bowl-fired", "attributes": { "ucontents": [ { "type": "item", "code": "waterportion", "makefull": true } ] } }, { "type": "block", "code": "bowl-fired", "attributes": { "ucontents": [ { "type": "item", "code": "honeyportion", "makefull": true } ] } }, { "type": "block", "code": "bowl-fired" }, { "type": "block", "code": "bowl-raw" } ] } ] }, A list of creative tabs to put items into. Note that all itemstacks in will be placed in all tabs. A list of item stacks to put in tabs. Note that every itemstack here will be placed in every entry. Reads the blocks and items from the Json files and converts them to an array of tabs which contain those blocks and items. The reader to read the json. The registry of blocks and items. Writes all the data to the BinaryWriter. The writer to write the save data The registry of blocks and items. Defines a set of properties that allow an object to be ground in a quern. "crushingPropsByType": { "ore-poor-ilmenite-*": { "crushedStack": { "type": "item", "code": "crushed-ilmenite" }, "quantity": { "avg": 1 }, "hardnessTier": 4 }, "ore-poor-cassiterite-*": { "crushedStack": { "type": "item", "code": "crushed-cassiterite" }, "quantity": { "avg": ".33" }, "hardnessTier": 1 }, }, If set, the block/item is crusable in a pulverizer and this is the resulting itemstack once the crushing time is over. The hardness tier for this collectible. Affects what pounder cap must be used for pulverization. - 0 = stone - 1 = copper - 2 = bronze - 3 = iron - 4 = steel The random quantity of item to return. Note that this value is multiplied by 's quantity. Makes a deep copy of the properties. Set to 1 for all decor blocks, or else they will not be rendered. (This intentionally prevents unloaded / unknown decor blocks from rendering) If true, do not cull even if parent face was culled (used e.g. for medium carpet, which stick out beyond the parent face) If true, alternates z-offset vertexflag by 1 in odd/even XZ positions to reduce z-fighting (used e.g. for medium carpets overlaying neighbours) IF true, this decor is NOT (at least) a full opaque face so that the parent block face still needs to be drawn If true, this decor is removable using the players hands, without breaking the parent block If true, this decor supplies its own different models for NSEWUD placement, if false the code will auto-rotate the model The offset to the BlockPos, to find the block which produced this selection box. Normally null. Used by Decor system (Could be developed in future for other blocks with selection boxes outside their own 1x1x1 block space e.g. opened gate?) The type of collectible in an itemstack. This itemstack holds a block. This itemstack holds an item. When picking a random seed for this block, what axes should we base it on? Create a random value based on all three axes. Create a random value based only on the X and Z axes. Allows blocks placed on top of each other to all have the same random properties (e.g. size, rotation, offset). Commonly used for multiblock plants. Types for each tool in the game. Some of these are unused. Defines a set of properties that allow an object to be ground in a quern. "grindingProps": { "groundStack": { "type": "item", "code": "bonemeal" } }, If set, the collectible is grindable in a quern and this is the resulting itemstack once the grinding time is over. Obsolete. Please use instead. Makes a deep copy of the properties. Defines a set of sounds for a collectible object. "heldSoundsbyType": { "*-lit-*": { "idle": "held/torch-idle", "equip": "held/torch-equip", "unequip": "held/torch-unequip", "attack": "held/torch-attack" } }, The path to a sound played when this item is being held. The path to a sound played when this item is equipped. The path to a sound played when this item is unequipped. The path to a sound played when this item is used to attack. The path to a sound played when this item is picked up in the inventory using the mouse. The path to a sound played when this item is placed in the inventory using the mouse. Clones the held sounds. The inventory attached to this block entity container The class name for the inventory. Called by EntityBlockFalling if required A collectible object that can be placed on the ground or on shelves or in display cases, but require custom code or rendering for it Return a custom mesh to be used for the collectible. Return null to use default item/block mesh. It is recommended to cache the returned mesh in the ObjectCache for efficieny. e.g. "shelf" or "ground" or "displaycase" This collectible was placed in-world and the chunk is about to get re-tesselated. A collectible object that can be placed on the ground or on shelves or in display cases, but also can still accept interactions from the player Represents a stack of items or blocks The base class the Item/Block inherits from Is it a Block or Item? The Item if ItemClass==Item, otherwise null The Block if ItemClass==Block, otherwise null Amount of items or blocks in this stack The items or blocks unique id Attributes assigned to this itemstack. Modifiable. Checks if this item stack is of the same class, id and has the same stack attributes. Ignores stack size Serializes this itemstack into a byte stream Deserializes an itemstack from given byte stream Checks if the contained item or block name contains given searchtext Returns the name displayed in the players inventory Returns a multiline description text of the item Whether to show additional debug info Creates a deep copy of the itemstack Wether its a block Block or Item The id of the block or item The item/block base class this stack is holding If this is a stack of items, this is the type of items it's holding, otherwise null If this is a stack of blocks, this is the type of block it's holding, otherwise null The amount of items/blocks in this stack The id of the block or item Attributes assigned to this particular itemstack which are saved and synchronized. Temporary Attributes assigned to this particular itemstack, not synchronized, not saved! Modifiable. The Attributes assigned to the underlying block/item. Should not be modified, as it applies to globally. Is it a Block or an Item? Create a new empty itemstack Create a new itemstack with given collectible id, itemclass, stacksize, attributes and a resolver to turn the collectibe + itemclass into an Item/Block Create a new itemstack from a byte serialized stream (without resolving the block/item) Create a new itemstack from a byte serialized array(without resolving the block/item) Create a new itemstack from a byte serialized stream (with resolving the block/item) Create a new itemstack from given block/item and given stack size Create a new itemstack from given item and given stack size Create a new itemstack from given block and given stack size Returns true if both stacks exactly match Returns true if this item stack is a satisfactory replacement for given itemstack. It's basically an Equals() test, but ignores additional attributes of the sourceStack Replace all the properties (id, class, attributes, stacksize, etc...) from this item stack by given stack Turn the itemstack into a simple string representation Serializes the itemstack into a series of bytes, including its stack attributes Serializes the itemstack into a series of bytes, including its stack attributes Reads all the itemstacks properties from a series of bytes, including its stack attributes Sets the item/block based on the currently set itemclass + id Returns true if searchText is found in the item/block name as supplied from GetName() Returns a human readable name of the item/block Returns a human readable description of the item/block Creates a full copy of the item stack Creates a full copy of the item stack, except for its stack size. This method should always be called when an itemstack got loaded from the savegame or when it got imported. When this method return false, you should discard the itemstack because it could not get resolved and a warning will be logged. Types for how an item can damage it's durability. The item was breaking a block. The item was attacking a creature. Unused. The item was thrown into a fire. Determines the kinds of storage types the item can be put into Of no particular type The item can be placed into a backpack slot The item can be placed in a slot related to mining or smithing The item can be placed in a slot related to jewelcrafting The item can be placed in a slot related to alchemy The item can be placed in a slot related to farming Moneys Clothes, Armor and Accessories Off hand slot Arrows Skill slot Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Custom storage flag for mods Represents an in game Item of Vintage Story The unique number of the item, dynamically assigned by the game The type of the collectible object The unique number of the item, dynamically assigned by the game The item's shape. Null for automatic shape based on the texture. Default textures to be used for this item. The Dictionary keys are the texture short names, as referenced in this item's shape ShapeElementFaces
(may be null on clients, prior to receipt of server assets)
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) Returns the first texture in Textures Instantiate a new item with null model transforms; ItemTypeNet will add default transforms client-side if they are null in the ItemType packet; transforms should not be needed on a server Instantiates a new item with given item id and stacksize = 1 Should return a random pixel within the items/blocks texture Creates a deep copy of the item This is a representation of an item stack in JSON. It resembles a standard in-game item stack but can be stored before the game is loaded. "output": { "type": "item", "code": "knifeblade-flint", "stacksize": 1 }, "output": { "type": "block", "code": "ladder-wood-north", "quantity": 3 }, Block or Item? The asset location code of the block or item. Amount of items in this stacks Alias of . No real need to use this instead of it. Tree Attributes that should be attached to the resulting itemstack. The resolved item after conversion. Sets itemstack.block or itemstack.item Creates a deep copy of this object Loads the ItemStack from the reader. The reader to get the ItemStack from The instancer for the ItemStack. Saves the ItemStack to file. The writer to save the item to. Controls the transformations of 3D shapes. Note that defaults change depending on where this class is used. Use '.tfedit' in game to help customize these values, just make sure to copy them into your json file when you finish. "tpHandTransform": { "translation": { "x": -0.87, "y": -0.01, "z": -0.56 }, "rotation": { "x": -90, "y": 0, "z": 0 }, "origin": { "x": 0.5, "y": 0, "z": 0.5 }, "scale": 0.8 }, Offsetting Rotation in degrees Sets the same scale of an object for all axes. Rotation/Scaling Origin For Gui Transform: Whether to slowly spin in gui item preview For Ground Transform: Whether to apply a random rotation to the dropped item No effect on other transforms Scaling per axis Converts the transform into a matrix. Clears the transformation values. Used for transformations applied to a block or item model. Uses values from but will assign defaults if not included. Use '.tfedit' in game to help customize these values, just make sure to copy them into your json file when you finish. "tpHandTransform": { "translation": { "x": -0.87, "y": -0.01, "z": -0.56 }, "rotation": { "x": -90, "y": 0, "z": 0 }, "origin": { "x": 0.5, "y": 0, "z": 0.5 }, "scale": 0.8 }, Gets a new model with all values set to default. Scale = 1, No Translation, Rotation by -45 deg in Y-Axis Scale = 1, No Translation, Rotation by -45 deg in Y-Axis Scale = 1, No Translation, Rotation by -45 deg in Y-Axis Scale = 1, No Translation, Rotation by -45 deg in Y-Axis, 1.5x scale Scale = 1, No Translation, No Rotation Scale = 1, No Translation, Rotation by 180 deg in X-Axis Scale = 1, No Translation, Rotation by 180 deg in X-Axis Creates a default transform for a model that is now on the ground Makes sure that Translation and Rotation is not null Clones this specific transform. A keyframe for model transformation. The frame number for the keyframe The new transform set for the keyframe. Types of nutrition for foods. Allows you to make collectibles edible, and adds data about their nutrition. "nutritionPropsByType": { "*-flyagaric-*": { "saturation": 80, "health": -6.5, "foodcategory": "Vegetable" }, "*-earthball-*": { "saturation": 80, "health": -8, "foodcategory": "Vegetable" }, ... The category of the food. The saturation restored by the food. Obsolete - Please use instead. How much eating this will affect the player's intoxication. The delay before that extra saturation starts to go away. The health restored by the food. Usually actually used to hurt the player with negative values. When an instance of this collectible is eaten, what item stack should be returned to the player? Possible example: Eating a 'meat on a stick' item would return a single stick. (Note: Bowl meals/liquids are specially designed to do this through their attributes and class.) Duplicates the nutrition properties, which includes cloning the stack that was eaten. Types of transition for items. For food, animals or non-organic materials. Can be dried. Can be burned. Can be cured, for meat. Generic 'other' conversion. Cheese ripening. Snow/ice melting. Glue hardening. Used for cooking recipes where the output has no perishableprops, but we still need a non-null TransitionableProperties (e.g. sulfuric acid in 1.20) This is a versatile way of allowing a collectible to change to another after a certain time in the inventory. "transitionablePropsByType": { "*-long-raw": [ { "type": "Dry", "freshHours": { "avg": 0 }, "transitionHours": { "avg": 168 }, "transitionedStack": { "type": "item", "code": "bowstave-long-dry" }, "transitionRatio": 1 } ] }, "transitionableProps": [ { "type": "Perish", "freshHours": { "avg": 120 }, "transitionHours": { "avg": 24 }, "transitionedStack": { "type": "item", "code": "rot" }, "transitionRatio": 0.5 } ], What kind of transition can it make? The amount of hours before this item starts the transitioning process. The amount of hours it takes for the item to transition, after has elapsed. The itemstack the collectible turns into upon transitioning. Conversion ratio of fresh stacksize to transitioned stack size Duplicates the properties, which includes cloning the stack that was eaten. The type of source the damage came from. The type of damage that was taken. The relative hit position of where the damage occured. The source entity the damage came from, if any The entity that caused this damage, e.g. the entity that threw the SourceEntity projectile, if any
NOTE: will be null for non-projectile damage e.g. melee attacks: to get the attacking entity properly for both melee and projectile damage, use GetCauseEntity() The source block the damage came from, if any the location of the damage source. Tier of the weapon used to damage the entity, if any The amount of knockback this damage will incur If is greater than zero, damage will be turned into damage over time and will be fully applied over this time.
If is set to 1, it will mean that damage will just be delayed by . If greater than zero, total damage will be split into this many portions, each applied in / time after another. If greater than zero, this damage will be turned into damage overt time effect with this type.
This is used to look for specific types of DoT effects. For example it can be used to stop bleeding with bandages. Fetches the location of the damage source from either SourcePos or SourceEntity Get the entity that caused the damage. If a projectile like a stone was thrown this will return the entity that threw the stone instead of the stone. The entity that caused the damage If we have a hitposition this returns the pitch between the attacker and the attacked position It came from a block in the world. It from another player. It came from falling too far. It came from being in water too long. It came from respawning. It came from the void. It came from the /kill command. It came from inside. It came from another entity. It came from an explostion. It came from a source not identified. It came from entity bleeding The death was caused by falling too far. The death was caused by damage from a block. The death was caused by loss of getting air when underwater. The death was caused by a strong concussive force to the forehead. The death was caused by an injury the player sustained. We don't know what killed ya. Despawned because it died. Completely burned up Despawned because the player (or players) moved out of ranged. A player picked up this item and is removed from the world. (ItemEntity -> Item) The region was unloaded. The last player disconnected from the game. The entity expired. The entity was removed. A list of mouse buttons. Used to signal to event handlers, but not actually a button: activated when the wheel is scrolled. A crafting recipe ingredient Is the itemstack an item or a block? The code of the item or block Attaches a name to a wildcard in an ingredient. This is used to substitute the value into the output. Only required if using a wildcard. The quantity of the itemstack required for the recipe. What attributes this itemstack must have to be a valid ingredient Optional attribute data that you can attach any data to. Used for some specific instances in code mods. Whether this crafting recipe ingredient should be regarded as a tool required to build this item. If true, the recipe will not consume the item but reduce its durability. If is set, this is the durability cost when the recipe is created. When using a wildcard in the item/block code, setting this field will limit the allowed variants When using a wildcard in the item/block code, setting this field will skip these variants If set, the crafting recipe will give back the consumed stack to be player upon crafting. Can also be used to produce multiple outputs for a recipe. The itemstack made from Code, Quantity and Attributes, populated by the engine Whether this recipe contains a wildcard, populated by the engine Turns Type, Code and Attributes into an IItemStack Checks whether or not the input satisfies as an ingredient for the recipe. Fills in the placeholder ingredients for the crafting recipe. An ingredient for a grid recipe. The character used in the grid recipe pattern that matches this ingredient. Generated when the recipe is loaded. Represents a crafting recipe to be made on the crafting grid. { "ingredientPattern": "GS,S_", "ingredients": { "G": { "type": "item", "code": "drygrass" }, "S": { "type": "item", "code": "stick" } }, "width": 2, "height": 2, "output": { "type": "item", "code": "firestarter" } } If set to false, the recipe will never be loaded. If loaded, you can use this field to disable recipes during runtime. The pattern of the ingredient. Order for a 3x3 recipe:
1 2 3
4 5 6
7 8 9
Order for a 2x2 recipe:
1 2
3 4
Commas seperate each horizontal row, and an underscore ( _ ) marks a space as empty.
Note: from game version 1.20.4, this becomes null on server-side after completion of recipe resolving during server start-up phase The recipes ingredients in any order, including the code used in the ingredient pattern.
Note: from game version 1.20.4, this becomes null on server-side after completion of recipe resolving during server start-up phase Required grid width for crafting this recipe Required grid height for crafting this recipe Info used by the handbook. By default, all recipes for an object will appear in a single preview. This allows you to split grid recipe previews into multiple. Used by the handbook. If false, will not appear in the "Created by" section The resulting stack when the recipe is created. Whether the order of input items should be respected Name of the recipe. Used for logging, and some specific uses. Recipes for repairing objects must contain 'repair' in the name. Optional attribute data that you can attach any data to. Useful for code mods, but also required when using liquid ingredients.
See dough.json grid recipe file for example. If set, only players with given trait can use this recipe. See config/traits.json for a list of traits. If true, the output item will have its durability averaged over the input items If set, it will copy over the itemstack attributes from given ingredient code Attributes from thise ingredients will be merged into output itemstack If '{code}' is used in ingredient code, allowed variants for this code should be specified in this map If '{code}' is used in ingredient code, skip variants for this code should be specified in this map A set of ingredients with their pattern codes resolved into a single object. Turns Ingredients into IItemStacks True on successful resolve Resolves Wildcards in the ingredients Puts the crafted itemstack into the output slot and consumes the required items from the input slots Check if this recipe matches given ingredients The player for trait testing. Can be null. Returns only the first matching itemstack, there may be multiple Serialized the recipe Deserializes the recipe Creates a deep copy Creates a recipe using a 3D voxel-based system. Used for recipes types such as clayforming, smithing, or stone-knapping. A 2D array of strings that are layered together to form the recipe. Use "#" for solid, and "_" or " " for a gap. An array of voxels, created from during loading. This array is cloned when a player starts creating the recipe. The number of layers in this recipe, in the Y-axis. A category code for this recipe type. Used for error logging. If true, the recipe is rotated 90 degrees in the Y axis. Resolves the recipe. Generates the voxels for the recipe. Serialized the recipe Deserializes the alloy Resolves Wildcards in the ingredients Matches the wildcards for the clay recipe. Creates a new base recipe type. Almost all recipe types extend from this. The resulting recipe type. The ID of the recipe. Automatically generated when the recipe is loaded. An array of ingredients for this recipe. If only using a single ingredient, see .
Required if not using . A single ingredient for this recipe. If you need to use more than one ingredient, see .
Required if not using . The output when the recipe is successful. Adds a name to this recipe. Used for logging, and determining helve hammer workability for smithing recipes. Should this recipe be loaded by the game? The amount of drag while travelling through water. The amount of drag while travelling through the air. The amount of drag while travelling on the ground. The amount of gravity applied per tick to this entity. If set, will test for entity collision every tick (expensive) Called after a physics tick has happened Amount of seconds left in the accumulator after physics ticking The basic class for all entities in the game Color used when the entity is being attacked World where the entity is spawned in. Available on the game client and server. The api, if you need it. Available on the game client and server. Used by AItasks for perfomance. When searching for nearby entities we distinguish between (A) Creatures and (B) Inanimate entitie. Inanimate entities are items on the ground, projectiles, armor stands, rafts, falling blocks etc
Note 1: Dead creatures / corpses count as a Creature. EntityPlayer is a Creature of course.
Note 2: Straw Dummy we count as a Creature, because weapons can target it and bees can attack it. In contrast, Armor Stand we count as Inanimate, because nothing should ever attack or target it. List of current entity tags. Synced after initialization. Synchronization can be triggered by calling 'MarkTagDirty()' method.
Dont set on client side, unless you setting it to the same value on server side at the same time.
If set only on server side, 'MarkTagDirty()' should be called to sync value with clients. This will trigger full entity synchronization, which can be performance heavy.
Tags are not saved into save file, and always loaded from entity type when entity is created. Indexes of tags are dynamically assigned on game start, and are not consistent between saves. The vanilla physics systems will call this method if a physics behavior was assigned to it. The game client for example requires this to be called for the current player to properly render the player. Available on the game client and server. Server simulated animations. Only takes care of stopping animations once they're done Set and Called by the Entities ServerSystem An uptime value running activities. Available on the game client and server. Not synchronized. Client position Server simulated position. May not exactly match the client positon Server simulated position copy. Needed by Entities server system to send pos updatess only if ServerPos differs noticably from PreviousServerPos The position where the entity last had contact with the ground. Set by the game client and server. The entities collision box. Offseted by the animation system when necessary. Set by the game client and server. The entities collision box. Not Offseted. Set by the game client and server. The entities selection box. Offseted by the animation system when necessary. Set by the game client and server. The entities selection box. Not Offseted. Set by the game client and server. Used by the teleporter block A unique identifier for this entity. Set by the game client and server. The range in blocks the entity has to be to a client to do physics and AI. When outside range, then will be set to inactive The face the entity is climbing on. Null if the entity is not climbing. Set by the game client and server. Set by the game client and server. True if this entity is in touch with the ground. Set by the game client and server. True if the bottom of the collisionbox is inside a liquid. Set by the game client and server. True if the collisionbox is 2/3rds submerged in liquid. Set by the game client and server. True if the entity is in touch with something solid on the vertical axis. Set by the game client and server. True if the entity is in touch with something solid on both horizontal axes. Set by the game client and server. The current entity state. NOT stored in WatchedAttributes in from/tobytes when sending to client as always set to Active on client-side Initialize(). Server-side if saved it would likely initially be Despawned when an entity is first loaded from the save due to entities being despawned during the UnloadChunks process, so let's make it always Despawned for consistent behavior (it will be set to Active/Inactive during Initialize() anyhow) Permanently stored entity attributes that are sent to client everytime they have been changed If entity debug mode is on, this info will be transitted to client and displayed above the entities head Permanently stored entity attributes that are only client or only server side Set by the client renderer when the entity was rendered last frame Set by the client renderer when the entity shadow was rendered last frame Set during initialization by calling Entity.GetTouchDistance(). A mod wishing to change the value returned by .GetTouchDistance() dynamically should probably call .updateColSelBoxes() or update this field directly The Entity's BehaviorRepulseAgents, if it has one - here for critical performance reasons. This may also be accessed from Physics ticking Invoked once per server tick, immediately following the physics ticking, if this Entity has any of the Physics behaviors. Example use, anything which requires an update of the entity's current position, such as BehaviorRepulseAgents Used by PhysicsManager. Added here to increase performance 0 = not tracked, 1 = lowResTracked, 2 = fullyTracked Used by PhysicsManager. Added here to increase performance Set to true when position packet prepared during physics ticking, set to false following AfterPhysicsTick() Used by the PhysicsManager to tell connected clients that the next entity position packet should not have its position change get interpolated. Gets set to false after the packet was sent If true, will call EntityBehavior.IntersectsRay. Default off to increase performance. If true, will fully simulate animations on the server so one has access to the positions of all attachment points. If false, only root level attachment points will be available server side Used for efficiency in multi-player servers, to avoid regenerating the packet again for each connected client Used for efficiency in multi-player servers, to speed up iterating over relevant behaviors only. These are the behaviors returning Threadsafe == false (which is the default) Used for efficiency in multi-player servers, to speed up iterating over relevant behaviors only. These are the behaviors returning Threadsafe == true; These behaviors may have their regular ticking (including ShouldExecute() etc) called EITHER from the main thread OR from another physics thread, depending on PhysicsManager logic Used only when deserialising an entity, otherwise null Should return true when this entity should be interactable by a player or other entities Used for passive physics simulation, together with the MaterialDensity to check how deep in the water the entity should float CollidedVertically || CollidedHorizontally ServerPos on server, Pos on client The height of the eyes for the given entity. If gravity should applied to this entity Determines on whether an entity floats on liquids or not and how strongly items get pushed by water. Water has a density of 1000. A density below 1000 means the entity floats on top of water if has a physics simulation behavior attached to it. If set, the entity will emit dynamic light If the entity should despawn next server tick. By default returns !Alive for non-creatures and creatures that don't have a Decay behavior Players and whatever the player rides on will be stored seperatly Whether this entity should always stay in Active model, regardless on how far away other player are True if the entity is in state active or inactive, or generally not dead (for non-living entities, 'dead' means ready to despawn) Used by some renderers to apply an overal color tint on the entity A small offset used to prevent players from clipping through the blocks above ladders: relevant if the entity's collision box is sometimes adjusted by the game code The chance that this entity, walking or jumping on or falling onto a block, will trigger a block-update - so potentially unstable dirt or sand falling, avalanche etc. Creates a new instance of an entity Creates a minimally populated entity with configurable tracking range, no Stats, no AnimManager and no animations attribute. Currently used by EntityItem. Called when the entity got hurt. On the client side, dmgSource is null Called when this entity got created or loaded Called when something tries to given an itemstack to this entity Is called before the entity is killed, should return what items this entity should drop. Return null or empty array for no drops. Teleports the entity to given position. Actual teleport is delayed until target chunk is loaded. Teleports the entity to given position Teleports the entity to given position Teleports the entity to given position Teleports the entity to given position Called when the entity should be receiving damage from given source True if the entity actually received damage Should return true if the entity can get damaged by given damageSource. Is called by ReceiveDamage. Called every 1/75 second Called by EntityShapeRenderer.cs before tesselating the entity shape Called when the entity collided vertically Called when the entity collided with something solid and was false before Called when the entity got in touch with a liquid Called when after the got loaded from the savegame (not called during spawn) Called when the entity spawns (not called when loaded from the savegame). Called when the entity despawns Called when the entity has left a liquid Called when an entity has interacted with this entity If being interacted with a block/item, this should be the slot the item is being held in Relative position on the entites hitbox where the entity interacted at 0 = attack, 1 = interact Called when a player looks at the entity with interaction help enabled Called by client when a new server pos arrived Called when on the client side something called capi.Network.SendEntityPacket() Called when on the server side something called sapi.Network.SendEntityPacket() Packetid = 1 is used for teleporting Packetid = 2 is used for BehaviorHarvestable Called by BehaviorCollectEntities of nearby entities. Should return the itemstack that should be collected. If the item stack was fully picked up, BehaviorCollectEntities will kill this entity Called on the server when the entity was changed from active to inactive state or vice versa Helper method to set the CollisionBox Adds given behavior to the entities list of active behaviors Removes given behavior to the entities list of active behaviors. Does nothing if the behavior has already been removed Create the cached arrays of thread-safe and mainthread behaviors, for ticking performance Returns true if the entity has given active behavior Returns the behavior instance for given entity. Returns null if it doesn't exist. Returns the first behavior instance for given entity of given type. Returns null if it doesn't exist. Returns itself and any behaviors that implement the interface T as a List Returns itself or the first behavior that implements the interface T Returns true if given activity is running Returns the remaining time on an activity in milliesconds Starts an activity for a given duration Updates the DebugAttributes tree In order to maintain legacy mod API compatibility of FromBytes(BinaryReader reader, bool isSync), we create an overload which server-side calling code will actually call, and store the remaps parameter in a field Loads the entity from a stored byte array from the SaveGame True if this is a sync operation, not a chunk read operation Serializes the slots contents to be stored in the SaveGame True when being used to send an entity to the client Relevant only for entities with heads, implemented in EntityAgent. Other sub-classes of Entity (if not EntityAgent) should similarly override this if the headYaw/headPitch are relevant to them Relevant only for entities with heads, implemented in EntityAgent. Other sub-classes of Entity (if not EntityAgent) should similarly override this if the headYaw/headPitch are relevant to them Revives the entity and heals for 9999. Makes the entity despawn. Entities only drop something on EnumDespawnReason.Death Assumes that it is only called on the server Should return true if this item can be picked up as an itemstack This method pings the Notify() method of all behaviors and ai tasks. Can be used to spread information to other creatures. This method is called by the BlockSchematic class a moment before a schematic containing this entity is getting exported. Since a schematic can be placed anywhere in the world, this method has to make sure the entities position is set to a value relative of the schematic origin point defined by startPos Right after calling this method, the world edit system will call .ToBytes() to serialize the entity This method is called by the BlockSchematic class a moment after a schematic containing this entity has been exported. Since a schematic can be placed anywhere in the world, this method has to make sure the entities position is set to the correct position in relation to the target position of the schematic to be imported. Called by the worldedit schematic exporter so that it can also export the mappings of items/blocks stored inside blockentities Called by the blockschematic loader so that you may fix any blockid/itemid mappings against the mapping of the savegame, if you store any collectibles in this blockentity. Note: Some vanilla blocks resolve randomized contents in this method. Hint: Use itemstack.FixMapping() to do the job for you. If you need some sort of randomness consistency accross an imported schematic, you can use this value Turn it off to spawn structures as they are. For example, in this mode, instead of traders, their meta spawners will spawn Used only during worldgen when an entity is placed by a schematic. Overall purpose is like OnLoadCollectibleMappings() except that it is called prior to initialising the Entity
Should typically do nothing and return false
May optionally load the collectible mappings here (doing any necessary initialisation itself, e.g. initialising the Inventory) in which case return true. For example, this is useful for Armorstands If returns true, the caller should skip calling OnLoadCollectibleMappings() Gets the name for this entity Gets the translated prefix and creature name, e.g. "a goat" gets the info text for the entity. Starts the animation for the entity. stops the animation for the entity. To test for player->entity selection. Is already preloaded with the ray The distance at which entities are counted as "touching" each other, for example used by EntityPartitioning and RepulseAgents
Note: from 1.20.4 this is gathered and cached in a field when each entity is Initialized, if for any reason a mod or behavior needs to change the result later than Initialization then you should also update the Entity field .touchDistance Triggers full entity synchronization, including entity tags. Should not be called too frequently. Returns true if all named tags are present Defines a basic entity behavior that can be attached to entities Initializes the entity.
If your code modifies the supplied attributes (not recommended!), then your changes will apply to all entities of the same type. The properties of this entity. The attributes of this entity. Called after initializing all the behaviors in case they need to cross-refer to each other or set some initial values only at spawn-time The event fired when a game ticks over. An implementing behavior can return true if it is thread-safe: allows the behavior to be multi-threaded for better multiplayer performance The event fired when the entity is spawned (not called when loaded from the savegame). The event fired when the entity is loaded from disk (not called during spawn) The event fired when the entity is despawned. The reason the entity despawned. The name of the property tied to this entity behavior. The event fired when the entity recieves damage. The source of the damage The amount of the damage. When the entity got revived (only for players and traders currently) The event fired when the entity falls to the ground. the point which the entity was previously on the ground. The vertical motion the entity had before landing on the ground. The event fired when the entity recieves saturation. The amount of saturation recieved. The category of food recieved. The delay before the loss of saturation. The event fired when the server position is changed. Whether or not this entity was teleported. How this event is handled. gets the drops for this specific entity. The world of this entity The block position of the entity. The player this entity was killed by. How this event was handled. the items dropped from this entity The event fired when the state of the entity is changed. The previous state. How this event was handled. The notify method bubbled up from entity.Notify() Gets the information text when highlighting this entity. The supplied stringbuilder information. The event fired when the entity dies. The source of damage for the entity. The event fired when the entity is interacted with by the player. The entity it was interacted with. The item slot involved (if any) The hit position of the entity. The interaction mode for the entity. How this event is handled. The event fired when the server receives a packet. The server player. the packet id. The data contents. How this event is handled. The event fired when the client receives a packet. Called when a player looks at the entity with interaction help enabled For entities which need to load collectible mappings before Initialisation during worldgen (e.g. Armorstand)
Return true if the collectible mappings were loaded by this This method is not called on the server side Can be used by the /entity command or maybe other commands, to test behaviors
The argument will be an object provided by TextCommandCallingArgs, which can then be cast to the desired type e.g. int The distance at which entities are counted as "touching" each other, for example used by EntityPartitioning and RepulseAgents
Note: from 1.20.4 this is gathered and cached in a field when each entity is Initialized, if for any reason a mod or behavior needs to change the result later than Initialization then you should also update the Entity field .touchDistance If true, then this entity will not retaliate if attacked by the specified eOther If false, then this entity will always retaliate (disregarding subsequent) Returns true if this entity behavior needs to remap inventory items/blocks when placed as part of a schematic during world generation. If true, EarlyLoadCollectibleMappings() will be called, during schematic placement, instead of OnLoadCollectibleMappings() The reason this entity despawned. In the case of death, this was the damage source. Represents all positional information of an entity, such as coordinates, motion and angles The yaw of the agents head The pitch of the agents head The X position of the Entity. The Y position of the Entity. Dimension unaware Y position of the Entity. The Z position of the Entity. The rotation around the X axis, in radians. The rotation around the Y axis, in radians. The rotation around the Z axis, in radians. Returns the position as BlockPos object Returns the position as a Vec3i object Returns the position as a Vec3d object. Note, dimension aware Returns the position as a Vec3f object Sets this position to a Vec3d, including setting the dimension The Vec3d to set to. Sets this position to a Vec3d, without dimension information - needed in some situations where no dimension change is intended The Vec3d to set to. Adds given position offset Returns itself Adds given position offset Returns itself Sets the entity position. Sets the entity position. Sets the entity position. Sets the entity position. Sets the entity angles. Sets the entity position. Sets the Yaw of this entity. Returns true if the entity is within given distance of the other entity Returns true if the entity is within given distance of given position Returns true if the entity is within given distance of given position Returns true if the entity is within given distance of given position Returns true if the entity is within given distance of given block position Returns true if the entity is within given distance of given position Returns true if the entity is within given distance of given position Returns the squared distance of the entity to this position Returns the squared distance of the entity to this position. Note: dimension aware, this requires the parameter y coordinate also to be based on InternalY as it should be (like EntityPos.XYZ) Returns the squared distance of the entity to this position. Note: dimension aware, this requires the parameter Vec3d pos.Y coordinate also to be based on InternalY as it should be (like EntityPos.XYZ) Returns the horizontal squared distance of the entity to this position Returns the squared distance of the entity to this position Creates a full copy Same as AheadCopy(1) - AheadCopy(0) Same as AheadCopy(1) - AheadCopy(0) Returns a new entity position that is in front of the position the entity is currently looking at Returns a new entity position that is in front of the position the entity is currently looking at using only the entities yaw, meaning the resulting coordinate will be always at the same y position. Returns a new entity position that is behind of the position the entity is currently looking at Makes a "basiclly equals" check on the position, motions and angles using a small tolerance of epsilon=0.0001f Makes a "basiclly equals" check on the position, motions and angles using a small tolerance of epsilon=0.0001f. Ignores motion Makes a "basiclly equals" check on position and motions using a small tolerance of epsilon=0.0001f. Ignores the entities angles. Loads the position and angles from given entity position. Returns itself Loads the position from given position. Returns itself Serializes all positional information. Does not write HeadYaw and HeadPitch. Deserializes all positional information. Does not read HeadYaw and HeadPitch Assigned on registering the entity type The entity code in the code. Variant values as resolved from blocktype/itemtype or entitytype The classification of the entity. List of entity tags ids Natural habitat of the entity. Decides whether to apply gravity or not The size of the entity's hitbox (default: 0.2f/0.2f) The size of the hitbox while the entity is dead. The size of the entity's hitbox (default: null, i.e. same as collision box) The size of the hitbox while the entity is dead. (default: null, i.e. same as dead collision box) How high the camera should be placed if this entity were to be controlled by the player The mass of this type of entity in kilograms, on average - defaults to 25kg (medium-low) if not set by the asset If true the entity can climb on walls If true the entity can climb anywhere. Whether the entity should take fall damage If less than one, mitigates fall damage (e.g. could be used for mountainous creatures); if more than one, increases fall damage (e.g fragile creatures?) Should the model in question rotate if climbing? The resistance to being pushed back by an impact. The attributes of the entity. These are the Attributes read from the entity type's JSON file.
If your code modifies these Attributes (not recommended!), the changes will apply to all entities of the same type. The client properties of the entity. The server properties of the entity. The sounds that this entity can make. The sounds this entity can make after being resolved. The chance that an idle sound will play for the entity. The sound range for the idle sound in blocks. The drops for the entity when they are killed. The collision box they have. Creates a copy of this object. Initalizes the properties for the entity. the entity to tie this to. The Core API Initializes the sounds for this entity type. The attributes of the entity type. Entity type behaviors When this property is attached to an entity - the behaviors attached of entity.
To modify this list, please call Entity.AddBehavior() or Entity.RemoveBehavior() Use this to make a deep copy of these properties. Set by the game client Name of there renderer system that draws this entity Directory of all available textures. First one will be default one
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) Set by a server at the end of asset loading, immediately prior to setting Textures to null; relevant to spawning entities with variant textures Used by various renderers to retrieve the entities texture it should be drawn with The glow level for the entity. Makes entities pitch forward and backwards when stepping The shape of the entity Only loaded for World.EntityTypes instances of EntityProperties, because it makes no sense to have 1000 loaded entities needing to load 1000 shapes. During entity load/spawn this value is assigned however. On the client it gets set by the EntityTextureAtlasManager. On the server by the EntitySimulation system The shape for this particular entity who owns this properties object The size of the entity (default: 1f) The rate at which the entity's size grows with age - used for chicks and other small baby animals The animations of the entity. Returns the first texture in Textures dict Initializes the client properties. Does not clone textures, but does clone Shape
Note: This method does not clone the LoadedShape (nor the LoadedAlternateShapes, if present). The LoadedShape (and any alternate) is not normally modified after entityType loading. An Entity created at runtime (each Entity carries a clone of its EntityProperties) should not normally require its own unique copy of the LoadedShape or the LoadedAlternateShapes. Exceptionally, an entity needing to clone and modify LoadedShape or one of the LoadedAlternateShapes (e.g. EntityDressedHumanoid, or a boat furling and unfurling sails) should do so in its own custom OnTesselation() method, likely accessing the shape via EntityClientProperties.LoadedShapeForEntity. The conditions for spawning the entity. Makes a copy of this EntiyServerProperties type Returns a list of all entity behaviors that return true for ShouldEarlyLoadCollectibleMappings
Note, these behaviors are temporarily created in this list only, not attached to the entity, and should be discarded by the caller Base class for entity rendering The current entity A reference to the client api Creates a new entity renderer instance Called when the entity is now fully either spawned or fully loaded Draw call with no shader initialized Draw call with the Entityanimated shader loaded and initialized with the correct color/fog/sunlight/texture values If shadows are enabled, then this method is called again with shadowmap shader intialized Ortho mode draw call for 2d gui stuff, like name tags. Gui shader initialized already. Called before gui rendering starts. Drawing of the whole model into a gui dialog. Gui shader initialized already. Called before in-world rendering starts Should free up all the resources Render call for the transparent pass Batched render call for the transparent pass A list of activities that an entity can perform. Called at a fixed interval, potentially 30 times per second (if server is running smoothly) Called once per server tick, after all physics ticking has occurred; on main thread. Interface for universal approach to spawning projectile entities.
Some of the properties may not be used by all projectiles. But they can still be set or read. Entity that spawned the projectile Projectile damage when hitting an entity. Projectile damage tier when hitting an entity. Projectile damage type when hitting an entity. If damage source done by projectile will ignore invincibility frames. Projectile item, can be dropped on impact, or damaged, or destroyed. Weapon item stack used to shoot this projectile. Chance for projectile to not be destroyed on impact. How much should be damage on impact. If projectile can be collected when stuck. Will return true if projectile hit at least one entity. Projectile wieght used for knockback calculations. If projectile is stuck in terrain. Sets initial rotation if needed. Should be called each time entity is spawned before it spawned. Applicable if the player is in fly mode or the entity isn't colliding with anything including liquid. Must be alive. Creative flight movement, possibly glider too? Config passed in from the behavior in the entity class. Can this be applied this tick? Apply a modifier to this entity. Relative value. bottom 0...1 sealevel, 1 .... 2 max-y 0...32 The servers playstyle A list of conditions based on climate. The minimum tempurature for the object to spawn. The maximum tempurature for the object to spawn. The minimum amount of rain for the object to spawn. The maximum amount of rain for the object to spawn. The minimum amount of forest cover needed for the object to spawn. The maximum amount of forest cover needed for the object to spawn. The minimum amount of shrubbery needed for the object to spawn. The maximum amount of shrubbery needed for the object to spawn. Won't span below minY. 0...1 is world bottom to sea level, 1...2 is sea level to world top Won't span above maxY. 0...1 is world bottom to sea level, 1...2 is sea level to world top The minimum amount of forest or shrubs for the object to spawn. The spawn conditions assigned to various things. "spawnconditions": { "worldgen": { "TriesPerChunk": { "avg": 0.1, "var": 0 }, "tryOnlySurface": true, "minLightLevel": 10, "groupSize": { "dist": "verynarrowgaussian", "avg": 3, "var": 4 }, "insideBlockCodes": [ "air", "tallgrass-*" ], "minTemp": 5, "maxTemp": 28, "minRain": 0.45, "minForest": 0.35, "companions": [ "pig-wild-female", "pig-wild-piglet" ] }, "runtime": { "group": "neutral", "tryOnlySurface": true, "chance": 0.0006, "maxQuantity": 4, "minLightLevel": 10, "groupSize": { "dist": "verynarrowgaussian", "avg": 3, "var": 4 }, "insideBlockCodes": [ "air", "tallgrass-*" ], "minTemp": 5, "maxTemp": 28, "minRain": 0.45, "minForestOrShrubs": 0.35, "companions": [ "pig-wild-female", "pig-wild-piglet" ] } } RecommendedNone Control specific spawn conditions based on climate. Note that this will override any climate values set in and . It is recommended to specify climate values here rather than setting them in the other spawn conditions. RecommendedNone Runtime requirements for the object to spawn. RecommendedNone Worldgen/region requirements for the object to spawn. Allows you to control spawn limits based on a set of entity codes using a wildcard. The maximum quantity for all entities that match the wildcard. A wildcard asset location which can group many entities together. A set of spawn conditions for chunks that have already been generated. Most properties are got from . The chance, usually between 0 (0% chance) and 1 (100% chance), for the entity to spawn during the spawning round. The max number of this entity that can ever exist in the world for a single player. With more than one player, the max number is actually (this)x(current player count)x(). Consider using to allow a max quantity based from many entities. The max quantity of objects to spawn based on a wildcard group of entities.
For example, using will allow a max of 20 pig-wild-male instances. Using this with a group of "pig-*" will allow a max of 20 pig entities, regardless if male, female, or piglet. The maximum number of this entity that can exist in the world is x (current player count) x (this). The minimum distance from the player that an object will spawn. Set server-side after this has been loaded once, used only for error logging purposes Creates a deep copy of this set of spawn conditions. A set of spawn conditions for when chunks are generated. Most properties are got from . The amount of times the object will attempt to spawn per chunk. A base class for entities spawning conditions. The group of the spawn conditions. Vanilla groups are:
- hostile
- neutral
- passive
Hostile creatures should be defined as such here. This will automatically stop them spawning with a grace timer, and in locations where hostiles should not spawn. The minimum light level for an object to spawn. The maximum light level for an object to spawn. The type of light counted for spawning purposes. the group size for the spawn. Obsolete. Use instead. Additional companions for the spawn. The blocks that the object will spawn in. Checks to see if the object requires solid ground. checks to see if the object can only spawn in the surface. Whether the rain and temperature values are referring to the worldgen values (i.e. yearly averages) or the current values at the moment of spawning. Represents an EntityPos thats synced over the network using a dirty flag and regular is-dirty checks Internally sets the value of X. This may cause desync. Internally sets the value of Y. This may cause desync. Internally sets the value of Z. This may cause desync. Sets the roll of the Entity Position. This may cause desync. Sets the yaw of the Entity Position. This may cause desync. Sets the pitch of the Entity Position. This may cause desync. Sets the stance of the Entity Position. This may cause desync. Marks the position as dirty- requiring a refresh from the server. Marks the position as clean- and not requiring a refresh from the server. null for returning back to default behavior (read shape from attributes) A goal-directed entity which observes and acts upon an environment No swivel when we are mounted The yaw of the agents body The yaw of the agents body on the client, retrieved from the server (BehaviorInterpolatePosition lerps this value and sets BodyYaw) True if all clients have to be informed about this entities death. Set to false once all clients have been notified Unique identifier for a herd Item in the left hand slot of the entity agent. Item in the right hand slot of the entity agent. Whether or not the entity should despawn. Whether or not the entity is allowed to despawn (Default: true) The controls for this entity. The server controls for this entity Are the eyes of this entity submerged in liquid? Attempts to mount this entity on a target. The mount to mount Whether it was mounted or not. Attempts to un-mount the player. Whether or not unmounting was successful Recieves the saturation from a food source. The amount of saturation recieved. The cat of food... err Category of food. The delay before the loss of saturation Whether or not the target should recieve saturation. The amount of saturation recieved. The cat of food... err Category of food. The delay before the loss of saturation updated by GetWalkSpeedMultiplier() updated by GetWalkSpeedMultiplier() Gets the walk speed multiplier. The amount of drag provided by the current ground. (Default: 0.3) Serializes the slots contents to be stored in the SaveGame Loads the entity from a stored byte array from the SaveGame Relevant only for entities with heads, implemented in EntityAgent. Other sub-classes of Entity (if not EntityAgent) should similarly override this if the headYaw/headPitch are relevant to them Relevant only for entities with heads, implemented in EntityAgent. Other sub-classes of Entity (if not EntityAgent) should similarly override this if the headYaw/headPitch are relevant to them Attempts to stop the hand action. Whether or not the action is cancelled or stopped. The reason for stopping the action. Whether the stop was cancelled or not. This walks the inventory for the entity agent. the event to fire while walking the inventory. If true, then this entity will not retaliate if attacked by the specified eOther Used to map chunks from load/save game and server-client packets to this specific entity. The position of saved chunks will include a reference to this index Whether or not the EntityChunky is interactable. A players in-world action No action - used when setting preCondition Walk forwards Walk backwards Walk sideways left Walk sideways right Jump Sneak Sprint mode Glide Sit on the ground Left mouse down Right mouse down Fly or swim up Fly or swim down Holding down the Ctrl key (which might have been remapped) Holding down the Shift key (which might have been remapped) Left mouse down Right mouse down The available controls to move around a character in a game world To execute a call handler registered by the engine. Don't use this one, use api.Input.InWorldAction instead. If true, the entity is either flying, gliding or swimming. If true, the entity has NoClip active. the axis lock for the fly plane. Current walking direction. Current flying direction Checks to see if the entity is attempting to move in any direction (excluding jumping) Whether or not the entity is flying. Whether or not the entity is climbing Whether or not the entity is aiming Whether or not the entity is currently stepping up a block If the player is currently using the currently held item in a special way (e.g. attacking with smithing hammer or eating an edible item) The block pos the player started using The movement speed multiplier. Whether or not this entity is dirty. A check for if the entity is moving in the direction it's facing. A check for if the entity is moving the opposite direction it's facing. A check to see if the entity is moving left the direction it's facing. A check to see if the entity is moving right the direction it's facing. A check whether to see if the entity is jumping. A check whether to see if the entity is sneaking. Use Controls.ShiftKey instead for mouse interaction modifiers, as it is a separable control.
A test for Sneak should be used only when we want to know whether the entity is crouching or using Sneak motion, which affects things like whether it is detectable by other entities, seen on the map, or how the shield is used A check to see whether the entity is gliding A check to see whether the entity is sitting on the floor. A check to see whether the entity is sprinting. Use Controls.CtrlKey instead for mouse interaction modifiers, as it is a separable control.
A test for Sprint should be used only when we want to know whether the entity is sprinting. A check to see whether the entity is moving up. A check to see whether the entity is moving down. A check to see if the entity is holding the in-world rleft mouse button down. A check to see if the entity is holding the in-world right mouse button down. A check to see if the entity is holding down the Ctrl key (which may be the same as the Sprint key or one or other may have been remapped).
Should normally be used in conjunction with a mouse button, including OnHeldInteractStart() methods etc A check to see if the entity is holding down the Shift key (which may be the same as the Sneak key or one or other may have been remapped).
Should normally be used in conjunction with a mouse button, including OnHeldInteractStart() methods etc Calculates the movement vectors for the player. The position of the player. The change in time. Copies the controls from the provided controls to this set of controls. The controls to copy over. Updates the data from the packet. Whether or not the key was pressed. the id of the key that was pressed. Forces the entity to stop all movements, resets all flags to false Converts the values to a single int flag. the compressed integer. Converts the int flags to movement controls. The compressed integer. The itemstack attached to this Item Entity. The UID of the player that dropped this itemstack. Returns the material density of the item. Whether or not the EntityItem is interactable. Get the HSV colors for the lighting. Builds and spawns an EntityItem from a provided ItemStack. The contents of the EntityItem The position of the EntityItem The velocity of the EntityItem The world the EntityItems preside in. A freshly baked EntityItem to introduce to the world. The block position previously selected by the player The block or blocks currently selected by the player The entity or entities selected by the player The reason the player died (if the player did die). Set only by the game server. The camera position of the player's view. Set only by the game client. An offset which can be applied to the camera position to achieve certain special effects or special features, for example Timeswitch feature. Set only by the game client. The yaw the player currently wants to walk towards to. Value set by the PlayerPhysics system. Set by the game client and server. The pitch the player currently wants to move to. Only relevant while swimming. Value set by the PlayerPhysics system. Set by the game client and server. Set this to hook into the foot step sound creator thingy. Currently used by the armor system to create armor step sounds. Called by the game client and server. Called when the player falls onto the ground. Called by the game client and server. Called whenever the game wants to spawn new creatures around the player. Called only by the game server. Used to assist if this EntityPlayer needs to be repartitioned This is not walkspeed per se, it is the walkspeed modifier as a result of armor and other gear. It corresponds to Stats.GetBlended("walkspeed") and gets updated every tick The player's internal Universal ID. Available on the client and the server. The players right hand contents. Available on the client and the server. The playres left hand contents. Available on the client and the server. The base player attached to this EntityPlayer. Returns null if there is no nearby sound source Might get intentionally modified if the nearest sound source the player is intersecting with is in an adjacent block Sets the current player. The selected Entity. The position of the selected entity. the facing of the entity. The hit position of the entity. Which selection box was aimed at. The index corresponds to the array returned by Block.GetSelectionBoxes() Set up a stat. Its not required to call this method, you can go straight to doing .Set() if your blend type is weighted sum. Also initializes a base value of 1. Set a stat value, if the stat catgory does not exist, it will create a new default one. Initializes a base value of 1 when creating a new stat. Remove a stat value Get the final stat value, blended by the stats blend type Types of creatures used for pathfinding. Humanoids prefer taking paths. Dumbest version. Never enters boiling water and lava. Prefers not to be in water. Slightly prefers to walk on blocks that give a walk speed bonus. Same as Default, Additionally never enters some types of blocks that are on fire (fire pits, coal piles and pit kilns) Same as LandCreature, additionally strongly prefers to walk on blocks that give a walk speed bonues, such as stone paths Does not avoid fire or boiling water. Still Avoids Lava Does not avoid water in any way Habitats for entities. Controls some minor logic for entities. No gravity, AiTaskWander will look for water or ice. Apply gravity. Standard land creature. No gravity. No gravity, AiTaskWander will look for water or ice. This contains data about an event that fires when a player changes which slot they're actively using. Such as the currently selected hotbar slot. The currently active slot being switched away from. The target slot that is being switched to. A players game mode Can not place or remove blocks, but can interact with blocks and entities May not fly or break blocks immediately Can fly, break blocks immediately, etc. Can fly but may not interact with the world in any way How the engine should handle attacking with an item in hands Uses the engine default behavior which is to play an attack animation and do block breaking/damage entities if in range. Will not call the *Step and *Stop methods. Uses the engine default behavior which is to play an attack or build animation and do block breaking/damage entities if in range, but also notify the server that the Use/Attack method has to be called serverside as well. Will call the *Step and *Stop methods. Do not play any default first person attack animation, but do block breaking/damage entities if in range. Notifies that the server that the Use/Attack method has to be called serverside as well. Will call the *Step and *Stop methods. Do play first person attack animation, don't break blocks/damage entities in range. Notifies that the server that the Use/Attack method has to be called serverside as well. Will call the *Step and *Stop methods. Do not play any first person attack animation, don't break blocks in range or damage entities in range. Notifies that the server that the Use/Attack method has to be called serverside as well. Will call the *Step and *Stop methods. Member Operator of this channel Owner of this channel Represents a player Returns the players privilege role The players player group memberships Load the players group that he is a member of Returns the membership data if player is part of this group, otherwise null List of the users entitlements, vanilla servers will list VIV and/or VS Team member entitlements The block the player is currently aiming at The entity the player is currently aiming at Get the players character name. The character name can be changed every 60 days in the account manager, so don't consider the players name as a unique identifier for a player. Use PlayerUID instead Returns the players identifier that is unique across all registered players and will never change. Use this to uniquely identify a player for all eternity. Shorthand for WorldData.PlayerUID The players current client id, 0 if not connected. This is the number thats assigned by the server for any connecting player. You probably don't need this number. The entity the player currently controls Some world-specific information about the player. This object is stored with the save game. If you modify it server side, be sure to call player.BroadcastPlayerData() to send it to affected clients. Returns the given players inventory manager that let's you do various interesting things with the players inventory. The list of privileges the player currently has access to (by role or direct assignment) This list is available for the playing player on the client, but not for other players. Check if a player has the given privilege The privilege to check true if the player has the given privilege, false otherwise Let's you do various interesting things with the players inventory. If the player currently holds a tool in the active hand, this value will be set If the player currently holds a tool in the off hand, this value will be set The players currently active hot bar slot Returns the currently selected hotbar slot. Might return null if there is no hotbar! Returns the off hand hotbar slot. Might return null if there is no hotbar! Dictionary of all inventories currently available to the player (some may however not be opened)
Note: for iterating through these, Inventories.Values will not be ordered. Instead use InventoriesOrdered if you want consistent ordering on server and client e.g. for shift-click operations An iterable collection of all inventories currently available to the player, arranged in the same order (by creation order) on both server and client to prevent syncing / ghosting issues List of inventories currently opened by the player Returns the slot that holds the currently dragged itemstack The slot the player currently hovers over with his mouse cursor Drops the current contents of the mouse slot onto the ground If false, will only drop 1 Drops the current contents of given slot onto the ground Produces a visual cue on given slot, if it's currently part of an inventory and visible to the player If called on server side, the server will send a network packet to notify the client. Returns the full inventory id for given inventory class name, e.g. GlobalConstants.creativeInvClassName Same as GetInventory() with playeruid appended to the inventoryClassName. Returns null if not found. You can use GlobalConstants.*ClassName to get the vanilla player inventories. Retrieve a players inventory. Returns null if not found. Gets the itemstack that in the given slot number of the players hotbar Returns the hotbar inventory object. Obvious comment is being obvious. Returns true if the invID is found, and the found IInventory value is in invFound; similar to Dictionary.TryGetValue, invFound is undefined if the result is false Returns a slot that would best fit the contents of the source slot. This checks all inventories currently opened by the player. Tries to move away items from the source slot into any other slot of another inventory Forces to place the item only into the players personal inventory One or more client packets that may be sent to the server for synchronisation Tries to move items from source slot to target slot (useful for client side inventory utilities) If successfull, a client packet that may be sent to the server for synchronisation Tries to add given itemstack to the players inventory Notifies the inventory manager that the player has opened an inventory. Should always be called on both sides (client and server). Only then interaction with other inventories becomes possible Notifies the inventory manager that the player has closed an inventory. Should always be called on both sides (client and server). After closing interaction with given inventory becomes no longer possible until reopened Like CloseInventory() but also sends the necessary packet to the server, if called from the client side: exactly like CloseInventory() if called from the server side Iterates over all inventory slots, returns true if your matcher returns true Shorthand for Inventories.ContainsValue(inventory) Will discard all of the players inventory contents Will drop all of the players inventory contents Drops the contents of given inventory Server Side: Resends the hotbar slot contents to all other clients to make sure they render the correct held item Client side: No effect Some world-specific information about a connected player. If you want modify any value, also broadcast the playerdata to all connected clients. This is the object that stored and loaded with the save game The players unique identifier The player entity this player is currently controlling The controls that moves around the EntityPlayer The players viewing distance in blocks that is allowed by the server The players desired viewing distance in blocks The players current game mode. Will return Spectator mode while the player is connecting. Whether the player can freely fly around Whether the player is forcefully kept on vertical or horizontal plane during freemove Affected by collision boxes or not The players movement speed Range of selectable blox Block selection mode Allows setting of arbitrary, permanantly stored moddata attached to this player. Not synced to client. Removes the permanently stored mod data Retrieve arbitrary, permantly stored mod data Tells the engine how to handle default or subsequent similar behaviors Do run default and subsequent behaviors/event listeneres, ignore return values Do run default and subsequent behaviors/event listeneres, use return values Do not execute the default behavior, but let subsequent behaviors/event listeneres still execute, use return values Do not execute default behavior and do not let subsequent behaviors/event listeneres execute, use return values Used to create a FrameProfilerUtil on threads other than the main thread Called by the game engine for each render frame or server tick Same as when was called before. Use this method like .Mark where the string has a second component (For performance, this avoids concatenating the strings unnecessarily, where the profiler is not enabled) Use this method to add a frame profiling marker, will set or add the time ellapsed since the previous mark to the frame profiling reults. Called by the game engine at the end of the render frame or server tick Implement this on a Block, BlockBehavior, BlockEntity or BlockEntityBehavior to allow it to be traversed for players with permissions to the land claim or if AllowUseEveryone or AllowTraverseEveryone is set. Return true if you want to allow this block to be interacted with when the player has traverse permissions on this land claim. Implement this if you need custom logic else it will just return true by default Don't affect the mounted entity angles Turn the player but allow him to still change its yaw Turn the player in all directions but allow him to still change its angles Fixate the mounted entity yaw to the mount Fixate all entity angles to the mount Attachment point name Represents something the player can mount. Usually a block or an entity. The seats of this mountable Position of this mountable StepPitch (pitching when stepping up or down a block) of this mountable - valid client-side only, taken from EntityShapeRenderer The entity that controls this mountable - there can only be one The entity which this mountable really is (for example raft, boat or elk) - may be null if the IMountable is a bed or other block The controls of the controlling seat (if any) Represents a seat of a mountable object. The entity behind this mountable supplier, if any The entity sitting on this seat The supplier of this mount provider. e.g. the raft entity for the 2 raft seats If this "mountable seat" is the one that controls the mountable entity/block How the mounted entity should rotate What animation the mounted entity should play Whether or not the mount should play the idle anim Where to place the first person camera Exact position of this seat Transformation matrix that can be used to render the mounted entity at the right position. The transform is relative to the SeatPosition. May be null. The control scheme of this seat When the entity unloads you should write whatever you need in here to reconstruct the IMountable after it's loaded again Reconstruct it by registering a mountable instancer through api.RegisterMountable(string className, GetMountableDelegate mountableInstancer) You must also set a string with key className, that is the same string that you used for RegisterMountable() Called when the entity unmounted himself Called when the entity mounted himself Return true if the currently mounted entity can unmount (or if not mounted in the first place) Used to get the control / main block of a multiblock structure and to test for access right in land claims Bag is a non-placed block container, usually one that is attached to an entity Should true if this this bag is empty Amount of slots this bag provides Should return all contents of this bag Save given itemstack into this bag Delete all contents of this bag The Hex color the bag item slot should take, return null for default The types of items that can be stored in this bag The contents of one or more bags Gets the enumerator for the inventory. A place holder inventory, useful, e.g., for when you want to render an itemstack and not have it spoil A single slot not attached to a given inventory. Basic interface representing an item inventory Convenience method to check if this inventory contains anything Wether or not to remove the inventory from the players inventory list upon closing it Called by item slot, if true, player cannot take items from this chest Called by item slot, if true, player cannot take items from this chest Milliseconds since server startup when the inventory was last changed (not used currently) Gets or sets the slot at the given slot number. Returns null for invalid slot number (below 0 or above Count-1). The setter allows for replacing slots with custom ones, though caution is advised. The name of the class for the inventory The internal named id for the inventory The slots marked dirty. Marks the inventory available for interaction for this player. Returns a open inventory packet that can be sent to the server for synchronization. Removes ability to interact with this inventory for this player. Returns a close inventory packet that can be sent to the server for synchronization. Checks if given player has this inventory currently opened Returns the best suited slot to hold the item from the source slot. Attached is also a weight, indicating how well the item is suited for it. If no suitable slot was found, the weight will be 0 and the slot will be null. A higher weight means the slot is better suited to hold the item. This method does not check if the player is actually allowed to access or modify this inventory. Weight will be 1 for a default slot that is empty Weight will be 2 for a default slot that can take one or more items from the source slot Weight could be 10 for an empty armor slot and the source slot contains an armor itemtack When the player clicks on this slot Attempts to flip the contents of both slots Will return -1 if the slot is not found in this inventory Server Side: Will resent the slot contents to the client and mark them dirty there as well Client Side: Will refresh stack size, model and stuff if this stack is currently being rendered Event that fires when a slot was modified Event that fires when NotifySlot was called The core API Gets the active slot packet. The slot ID The operation of the slot. Flips the items between the source slot and target slot. The inventory. The source slot ID The target slot ID Handles the client packet. The player the packet came from the ID of the packet. the contents of the packet. Opens a target inventory, passing it to the player. Closes the target inventory attached to a player. Custom transition speed handler Multiplier set by other configuration, if any, otherwise 1 Basic class representing an item inventory The world in which the inventory is operating in. Gives inventories access to block types, item types and the ability to drop items on the ground. Optional field that can be used to define in-world position of the inventory. Is set by most container block entities. Might be null! Optional field, if set, will check against the collectible dimensions and deny placecment if too large Is this inventory generally better suited to hold items? (e.g. set to 3 for armor in armor inventory, 2 for any item in hotbar inventory, 1 for any item in normal inventory) The name of the class for the invnentory. the ID of the instance for the inventory. (Not implemented!) The time it was last changed since the server was started. The players that had opened the inventory. The network utility for the inventory Slots that have been recently modified. This list is used on the server to update the clients (then cleared) and on the client to redraw itemstacks in guis (then cleared) The internal name of the inventory instance. The class name of the inventory. Milliseconds since server startup when the inventory was last changed Returns the number of slots in this inventory. Gets or sets the slot at the given slot number. Returns null for invalid slot number (below 0 or above Count-1). The setter allows for replacing slots with custom ones, though caution is advised. True if this inventory has to be resent to the client or when the client has to redraw them The slots that have been modified server side and need to be resent to the client or need to be redrawn on the client Called by item slot, if true, player cannot take items from this inventory Called by item slot, if true, player cannot put items into this inventory If true, the inventory will be removed from the list of available inventories once closed (i.e. is not a personal inventory that the player carries with him) Called whenever a slot has been modified Called whenever a slot notification event has been fired. Is used by the slot grid gui element to visually wiggle the slot contents Called whenever this inventory was opened Called whenever this inventory was closed If set, the value is returned when GetTransitionSpeedMul() is called instead of the default value. Convenience method to check if this inventory contains anything Returns the first slot that is not empty or null If opening or closing should produce a log line in the audit log. Since when items are moved the source and destination is logged already Create a new instance of an inventory. You may choose any value for className and instanceID, but if more than one of these inventories can be opened at the same time, make sure for both of them to have a different id Create a new instance of an inventory. InvetoryID must have the format [className]-[instanceId]. You may choose any value for className and instanceID, but if more than one of these inventories can be opened at the same time, make sure for both of them to have a different id You can initialize an InventoryBase with null as parameters and use LateInitialize to set these values later. This is sometimes required during chunk loading. The event fired after all the blocks have loaded. Tells the invnetory to update blocks and items within the invnetory. Will return -1 if the slot is not found in this inventory Gets the best sorted slot for the given item. The source item slot. Can be null. If provided allows the inventory to make a better guess at suitability The slots to skip. A weighted slot set. How well a stack fits into this inventory. By default 1 for new itemstacks and 3 for an itemstack merge. Chests and other stationary container also add a +1 to the suitability if the source slot is from the players inventory. Attempts to flip the contents of both slots Determines whether or not the player can access the invnetory. The player attempting access. The postion of the entity. Determines whether or not the player can modify the invnetory. The player attempting access. The postion of the entity. The event fired when the search is applied to the item. Call when a player has clicked on this slot. The source slot is the mouse cursor slot. This handles the logic of either taking, putting or exchanging items. The appropriate packet needed to reflect the changes on the opposing side Called when one of the containing slots has been modified Called when one of the containing slots has been modified If non null the itemstack that was taken out Called when one of the containing slot was notified via NotifySlot Called when the game is loaded or loaded from server Called when the game is saved or sent to client Attempts to flip the inventory slots. The player owner of the invnetory slots. The IDs of the player inventory. The IDs of the target inventory. The times these ids were last changed. Attempts to move the item stack from the inventory to another slot. The player moving the items The player inventory IDs The target Ids The operation type. Attempts to get specified slots if the slots exists. The player owning the slots The inventory IDs The slot ids The slots obtained. Creates a collection of slots from a tree. The tree to build slots from pre-existing slots. (default: null) Pre-modified slots. (default: null) Sets the tree attribute using the slots. Gets a specified number of empty slots. the number of empty slots to get. The pre-specified slots. A command to build a new empty slot. the index of the slot. An empty slot bound to this inventory. Server Side: Will resent the slot contents to the client and mark them dirty there as well Client Side: Will refresh stack size, model and stuff if this stack is currently being rendered Discards everything in the item slots. Drops the contents of the specified slots in the world. The position of the inventory attached to the slots. The slots to have their inventory drop. Drops the contents of all the slots into the world. Where to drop all this stuff. If non-zero, will split up the stacks into stacks of give max stack size Deletes the contents of all the slots Does this inventory speed up or slow down a transition for given itemstack? (Default: 1 for perish and 0 otherwise) Marks the inventory available for interaction for this player. Returns a open inventory packet that can be sent to the server for synchronization. Removes ability to interact with this inventory for this player. Returns a close inventory packet that can be sent to the server for synchronization. Checks if given player has this inventory currently opened Gets the enumerator for the inventory. Return the slot where a chute may push items into. Return null if it shouldn't move items into this inventory. Return the slot where a chute may pull items from. Return null if it is now allowed to pull any items from this inventory Abstract class used for all inventories that are "on" the player. Any inventory not inheriting from this class will not be stored to the savegame as part of the players inventory. The player ID for the inventory. The owning player of this inventory A general purpose inventory which sends update packets to nearby players (used for rendering Display Case, Pulveriser, etc) Called when one of the containing slots has been modified (the base version of this is empty) A general purpose inventory Creates an empty (invalid) inventory. Must call init() to propery init the inventory Create a new general purpose inventory Create a new general purpose inventory Amount of available slots Get slot for given slot index Loads the slot contents from given treeAttribute Stores the slot contents to invtree Called when initializing the inventory or when loading the contents allow the server to resend changed PlayerQuantities The default item slot to item stacks Can be used to interecept marked dirty calls. The upper holding limit of the slot itself. Standard slots are only limited by the item stacks maxstack size. Gets the inventory attached to this ItemSlot. Icon name to be drawn in the slot background If set will be used as the background color The ItemStack contained within the slot. The number of items in the stack. Whether or not the stack is empty. The storage type of this slot. Create a new instance of an item slot Amount of space left, independent of item MaxStacksize Whether or not this slot can take the item from the source slot. Whether or not this slot can hold the item from the source slot. Whether or not this slots item can be retrieved. Gets the entire contents of the stack, setting the base stack to null. Gets some of the contents of the stack. The amount to get from the stack. The stack with the quantity take out (or as much as was available) Attempts to place item in this slot into the target slot. Amount of moved items Returns the quantity of items that were not merged (left over in the source slot) Amount of moved items Attempts to flip the ItemSlots. Whether or no the flip was successful. Forces a flip with the given ItemSlot Called when a player has clicked on this slot. The source slot is the mouse cursor slot. This handles the logic of either taking, putting or exchanging items. Activates the left click functions of the given slot. Activates the middle click functions of the given slot. Activates the right click functions of the given slot. The event fired when the slot is modified. Marks the slot as dirty which queues it up for saving and resends it to the clients. Does not sync from client to server. Gets the name of the itemstack- if it exists. The name of the itemStack or null. Gets the StackDescription for the item. The world the item resides in. Whether or not we have Extended Debug Info enabled. A slot that can hold mobile containers Checks to see what dress type the given item is. A slot that only accepts collectibles designated for the off-hand slot A slot from which the player can only take stuff out of, but not place anything in it Standard survival mode slot that can hold everything except full backpacks A universal item slot type that can hold anything. Automatic merge operation, when a player did not specifically request a merge, e.g. with shift + left click, or when collected from the ground When using mouse to manually merge item stacks Confirmed merge via dialog. Not implemented as of v1.14 The world that the move operation is being performed. The acting player within the world. The mouse button the ActingPlayer has pressed. Any modifiers that the ActingPlayer is using for the operation (Ctrl, shift, alt) The current Priority for merging slots. The required Priority (can be null) The confirmation message code for this operation. The amount requested. The amount moveable. The amount moved. The amount not moved. Checks if the Shift Key is held down. Checks if the Ctrl key is held down. Checks if the Alt key is held down. Converts this MoveOperation to a Merge Operation. The slot to put items. The slot to take items. The slot that the item is attempting transfer to. The slot that the item is being transferred from The slot that is weighted. The weight of the slot. Other groups allowed to use this land Other players allowed to use this land Other players allowed to use this land, name of the player at the time the privilege was granted Ignores y-values Represents a shape animation and can calculate the transformation matrices for each frame to be sent to the shader Process 1. For each frame, for each root element, calculate the transformation matrix. Curent model matrix is identy mat. 1.1. Get previous and next key frame. Apply translation, rotation and scale to model matrix. 1.2. Store this matrix as animationmatrix in list 1.3. For each child element 1.3.1. Multiply local transformation matrix with the animation matrix. This matrix is now the curent model matrix. Go to 1 with child elements as root elems 2. For each frame, for each joint 2.1. Calculate the inverse model matrix 2.2. Multiply stored animationmatrix with the inverse model matrix 3. done Compiles the animation into a bunch of matrices, 31 matrices per frame. When false, will only do root elements Animations of this cache. The root elements of this cache. The poses of this cache Clears the animation cache. Clears the animation cache. Initializes the cache to the Animation Manager then spits it back out. The frame number. The transformations for the root element of the frame. Sets the transform of a particular joint ID. Finalizes the matricies with joints assigned by their ID. The ID of the joint. The attached ShapeElement. Takes the transform and inverses it. The ID of the keyframe. The elements of the keyframe. Resolves the keyframe animation for which elements are important. Resolves the keyframe animation for which elements are important. Are the animations dirty in this AnimationManager? The animator for the animation manager. The entity head controller for this animator. The list of currently active animations that should be playing The entity attached to this Animation Manager. Initializes the Animation Manager. The Core API. The entity this manager is attached to. If given animation is running, will set its progress to the first animation frame As StartAnimation, except that it does not attempt to start the animation if the named animation is non-existent for this entity Client: Starts given animation Server: Sends all active anims to all connected clients then purges the ActiveAnimationsByAnimCode list Start a new animation defined in the entity config file. If it's not defined, it won't play. Use StartAnimation(AnimationMetaData animdata) to circumvent the entity config anim data. Anim config code, not the animation code! Stops given animation The event fired when the manager recieves the server animations. Serializes the animations to be stored in the SaveGame For performance, serializes the animations to be stored directly to the provided stream Loads the entity from a stored byte array from the SaveGame The event fired at each server tick. The event fired each time the client ticks. Disposes of the animation manager. Defines how multiple animations should be blended together. Add the animation without taking other animations into considerations Add the pose and average it together with all other running animations with blendmode Average or AddAverage Add the animation without taking other animations into consideration, but add it's weight for averaging Data about when an animation should be triggered. An array of controls that should begin the animation. If set to true, all OnControls elements need to be happening simultaneously to trigger the animation. If set to false, at least one OnControls element needs to be happening to trigger the animation. Defaults to false. Is this animation the default animation for the entity? Animation Meta Data is a json type that controls how an animation should be played. "animations": [ { "code": "hurt", "animation": "hurt", "animationSpeed": 2.2, "weight": 10, "blendMode": "AddAverage" }, { "code": "die", "animation": "death", "animationSpeed": 1.25, "weight": 10, "blendMode": "Average", "triggeredBy": { "onControls": [ "dead" ] } }, { "code": "idle", "animation": "idle", "blendMode": "AddAverage", "easeOutSpeed": 4, "triggeredBy": { "defaultAnim": true } }, { "code": "walk", "animation": "walk", "weight": 5 } ] Unique identifier to be able to reference this AnimationMetaData instance Custom attributes that can be used for the animation. Valid vanilla attributes are:
- damageAtFrame (float)
- soundAtFrame (float)
- authorative (bool)
 The animations code identifier that we want to play The weight of this animation. When using multiple animations at a time, this controls the significance of each animation. The method for determining final animation values depends on this and . A way of specifying for each element. Also see to control blend modes per element.. The speed this animation should play at. Should this animation speed be multiplied by the movement speed of the entity? This property can be used in cases where a animation with high weight is played alongside another animation with low element weight. In these cases, the easeIn become unaturally fast. Setting a value of 0.8f or similar here addresses this issue.
- 0f = uncapped weight
- 0.5f = weight cannot exceed 2
- 1f = weight cannot exceed 1 A multiplier applied to the weight value to "ease in" the animation. Choose a high value for looping animations or it will be glitchy A multiplier applied to the weight value to "ease out" the animation. Choose a high value for looping animations or it will be glitchy Controls when this animation should be played. The animation blend mode. Controls how this animation will react with other concurrent animations. Also see to control blend mode per element. A way of specifying per element. Should this animation stop default animations from playing? A value that determines whether to change the first-person eye position for the camera. Higher values will keep eye position static. If true, the server does not sync this animation. Not a deep clone of all fields. Scalar fields, for example AnimationSpeed, are fresh copies and can be changed dynamically or per-entity, after cloning the AnimationMetaData.
For performance reasons, the non-scalar fields such as the Attributes, ElementWeight, ElementBlendMode and TriggeredBy are not deep-cloned as these fields are usually unchanging for all entities using the animation.
Note: If any implementing entity needs to change the non-scalar fields dynamically, or on a per-entity basis, that entity's code can clone and replace the object in its own individual copy of the AnimationMetaData. e.g. EntityDrifter replaces .TriggeredBy in some of its animations Syncs every frame with entity.ActiveAnimationsByAnimCode, starts, progresses and stops animations when necessary A RunningAnimation object for each of the possible Animations for this object We skip the last row - https://stackoverflow.com/questions/32565827/whats-the-purpose-of-magic-4-of-last-row-in-matrix-4x4-for-3d-graphics The entity's default pose. Meaning for most elements this is the identity matrix, with exception of individually controlled elements such as the head. The return value of false indicates the animation stopped, and requires removal from activeAnimationsByAnimCode this tick (it could also stop and be removed NEXT tick...) False if the animation should immediately stop; true otherwise Syncs every frame with entity.ActiveAnimationsByAnimCode, starts and stops animations when necessary and does recursive interpolation on the rotation, position and scale value for each frame, for each element and for each active element this produces always correctly blended animations but is significantly more costly for the cpu when compared to the technique used by the . The position of an element. The element this positioning is for. The model matrix of this element. The event fired when the game ticks. The current model matrix for this attachment point for this entity for the current animation frame. The pose shared across all entities using the same shape. Don't use. It's used internally for calculating the animation state. Once calculated, the value is copied over to AnimModelMatrix The attachment point The 30 pose transformation matrices that go to the shader Amount of currently active animations Holds data over all animations. This list always contains all animations of the creature. You have to check yourself which of them are active Whether or not to calculate the animation matrices, required for GetAttachmentPointPose() to deliver correct values. Default on on the client, server side only on when the creature is dead Gets the attachment point pose. The event fired on each frame. Everything needed for allowing animations the class holds a reference to an IAnimator. Currently implemented by The animator for this animation manager The head controller for this manager. Initialization call for the animation manager. The core API The entity being animated. Whether or not the animation is dirty. Starts an animation based on the AnimationMetaData, if it exists; returns false if it does not exist (or if unable to start it, e.g. because it is already playing) Starts an animation based on the AnimationMetaData Starts an animation based on JSON code. The json code. Stops the animation. The code to stop the animation on Stops all currently playing animations Additional attributes applied to the animation Additional attributes applied from the animation Gets the AnimationMetaData for the target action. The event fired when the client recieves the server animations all of active animations the number of the animations The speed of those animations. The event fired when the animation is stopped. The code that the animation stopped with. If given animation is running, will set its progress to the first animation frame A NoAnimator built off of The matrices for this No-Animator The active animation count for this no animator. Gets the attachment point for this pose. The event fired when a specified frame has been hit. A No-Animation Manager built off of . The animation is required to be active: if not started it should now start; if it ever ceases to be Active it should do whatever stop behavior is required (e.g. ease-out) The animation is currently running in any way, including play-till-end after it is no longer active Between 0 and 1 This is a spot on the shape that connects to another shape. The parent element of this attachment point. The json code of this attachment point. The X position of the attachment point. The Y position of the attachment point. The Z position of the attachment point. The forward vertical rotation of the attachment point. The forward horizontal rotation of the attachment point the left/right tilt of the attachment point Types of shape that can be loaded by the game. (Recommended) Imports a shape using the default JSON system. Imports a shape using an Obj file. Imports a shape using a Gltf file. Holds shape data to create 3D representations of objects. Also allows shapes to be overlayed on top of one another recursively. "shape": { "base": "block/basic/cube" }, "shapeInventory": { "base": "block/plant/bamboo/{color}/{part}-1", "overlays": [ { "base": "block/plant/bamboo/{color}/{part}lod0-1" } ] }, The path to this shape file. The format/filetype of this shape. Whether or not to insert baked in textures for mesh formats such as gltf into the texture atlas. How much, in degrees, should this shape be rotated around the X axis? How much, in degrees, should this shape be rotated around the Y axis? How much, in degrees, should this shape be rotated around the Z axis? How much should this shape be offset on X axis? How much should this shape be offset on Y axis? How much should this shape be offset on Z axis? The scale of this shape on all axes. The block shape may consists of any amount of alternatives, one of which will be randomly chosen when the shape is chosen. Includes the base shape The shape will render all overlays on top of this shape. Can be used to group multiple shapes into one composite shape. If true, the shape is created from a voxelized version of the first defined texture If non zero will only tesselate the first n elements of the shape If set will only tesselate elements with given name If set will not tesselate elements with given name Creates a deep copy of the composite shape Creates a deep copy of the shape, but omitting its alternates (used to populate the alternates) Alias to LoadAlternates Expands the Composite Shape and populates the Baked field Adds a tesselator to your block WARNING: please make sure whatever functions and fields you use with the OnTesselation event are THREAD SAFE! The base shape for all json objects. The collection of textures in the shape. The Dictionary keys are the texture short names, used in each ShapeElementFace
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) The elements of the shape. The animations for the shape. The width of the texture. (default: 16) The height of the texture (default: 16) Attempts to resolve all references within the shape. Logs missing references them to the errorLogger Prefixes texturePrefixCode to all textures in this shape. Required pre-step for stepparenting. The long arguments StepParentShape() calls this method. Adds a step parented shape to this shape. If you plan to cache the childShape use the shorter argument method and call SubclassForStepParenting() only once on it Adds a step parented shape to this shape, does not call the required pre-step SubclassForStepParenting() Collects all the elements in the shape recursively. Resolves all joints and loads them. Tries to load the shape from the specified JSON file, with error logging
Returns null if the file could not be found, or if there was an error Tries to load the shape from the specified JSON file, with error logging
Returns null if the file could not be found, or if there was an error Recursively searches the element by name from the shape. The name of the element to get. Ignored but retained for API backwards compatibility. The implementation always uses OrdinalIgnoreCase comparison The shape element or null if none was found Removes *all* elements with given name Creates a deep copy of the shape. If the shape has animations, then it also resolves references and joints to ensure the cloned shape is fully initialized A shape element built from JSON data within the model. A static reference to the logger (null on a server) - we don't want to hold a reference to the platform or api in every ShapeElement The name of the ShapeElement Whether or not the shape element is shaded. The faces of the shape element by name (will normally be null except during object deserialization: use FacesResolved instead!) An array holding the faces of this shape element in BlockFacing order: North, East, South, West, Up, Down. May be null if not present or not enabled.
Note: from game version 1.20.4, this is null on server-side (except during asset loading start-up stage) The origin point for rotation. The forward vertical rotation of the shape element. The forward vertical rotation of the shape element. The left/right tilt of the shape element How far away are the left/right sides of the shape from the center How far away are the top/bottom sides of the shape from the center How far away are the front/back sides of the shape from the center. Set this to true to disable randomDrawOffset and randomRotations on this specific element (e.g. used for the ice element of Coopers Reeds in Ice) The child shapes of this shape element The attachment points for this shape. The "remote" parent for this element The parent element reference for this shape. The id of the joint attached to the parent element. For entity animations Walks the element tree and collects all parents, starting with the root element Returns the full inverse model matrix (includes all parent transforms) The texture of the face. The UV array of the face. The rotation of the face. The glow on the face. Whether or not the element is enabled. You can export one of these by making a selection with worldedit, looking at the center block (which should be your controller/master) then typing /we mgencode. Please note, air blocks are not exported Check if the multiblock structure is complete. Ignores air blocks Used to add a set of particle properties to a collectible. Allows each particle to randomly change its velocity over time. If true, particle dies if it falls below the rain height at its given location More particles that spawn from this particle over time. See to control rate. More particles that spawn when this particle dies. The inverval that the spawn. The amount of velocity to be kept when this particle collides with something. Directional velocity is multipled by (-Bounciness * 0.65) on any collision. Whether or not the particle dies in air. Whether or not the particle dies in water. Whether or not the particle floats on liquids. The Hue/Saturation/Value/Alpha for the color of the particle. Whether or not to color the particle by the block it's on. A transforming opacity value. A transforming Red value. A transforming Green value. A transforming Blue value. The gravity effect on the particle. The life length, in seconds, of the particle. Offset from the blocks hitboxes top middle position The quantity of the particles given. The size of the particles given. A transforming Size value. The velocity of the particles. A dynamic velocity value. Sets the base model for the particle. The level of glow in the particle. Whether or not the particle is self propelled. Whether or not the particle collides with the terrain. How much the particles are affected by wind. The base position for the particles. The base block for the particle. Initializes the particle. The core API. When HsvaColor is null, this is used Converts the color to RGBA. The Core Client API. The set RGBA color. Gets the position of the particle in world. gets the quantity released. Gets the dynamic size of the particle. Gets the velocity of the particle. Begins the advanced particle. Gets the secondary spawn interval. prepares the particle for secondary spawning. The base position of the bubble particle. The velocity to add to the bubble particle. Initializes the bubble particle. The core API. Gets the secondary particles null, the bubble particles don't have secondary particles. Gets the death particles. There are no death particles for bubbles. Whether or not the bubbles die in air. Yes they die in air. Whether or not the bubbles die in liquid. They don't. Whether or not the bubbles die in liquid. They don't. Gets the glow level of the bubbles. No glow. Gets the gravity applied to the particle. None. Whether or not the bubble collides with the terrain. Gets the length of life for the particle. 0.25f The base model of the particle. It's a cube. This particle is not self propelled. This particle does not save to file. This particle does not load from file. The position of the particle The amount of particles. The radius of the particle emission. The scale of the particles. The position of the collision to create these particles. The contents that the particles are built off of. The amount of particles to be released. The radius to release the particles. The scale of the particles. Abstract class used for BlockVoxelParticles and ItemVoxelParticles Types of model for a particle. A 2D quad. A 3D cube. A subclass of ExplosionSmokeParticles. Handles the smoke particles of where the explosion was. Represents a provider of particle properties to be used when generating a particle If true, will be be spawned in the async particle system, which does not affect main game performance, recommended for large quantities of particles, slightly less optimal for particles that spawn very often Called before the particle provider is used for particle creation Called just before a new particle is being created. You can use this to produce e.g. alternating kinds of particles Whether the particle should despawn when in contact with liquids Whether the particle should despawn when in contact with air (e.g. for water bubbles) If true, particle dies if it falls below the rain height at its given location How many particles should spawn? For every particle spawned, all of belows methods are called once. E.g. if quantity is 10, GetPos(), GetVelocity(),... is called 10 times. Position in the world where the particle should spawn In what direction should the particle fly/fall The particles Rgba Color If this particle emits light, this is its RGBA. Does not actually brighten the scene around it, but prevents incorrect lighting of particles when everything else around it is dark Return null or 1 if opacity should remain unchanged over time. lifetimeLeft is always a value between 0 and 1 Return null or 1 if opacity should remain unchanged over time. lifetimeLeft is always a value between 0 and 1 Return null or 1 if opacity should remain unchanged over time. lifetimeLeft is always a value between 0 and 1 Return null or 1 if opacity should remain unchanged over time. lifetimeLeft is always a value between 0 and 1 Cube or Quad? Size of the particle Size change over time Velocity change over time (acts as a multiplier to the velocity) How strongly the particle is affected by gravity (0 = no gravity applied) How long the particle should live (default = 1) See also If true, a particle will restore it's initial velocity once it's obstruction has been cleared e.g. Smokes will start flying upwards again if is currently stuck under a block and the block is removed If true, the particle will collide with the terrain For sending over the network For reading from the network Determines the interval of time that must elapse during it's parent particle's lifetime before this one will spawn. This is only honored if this particle is defined as a secondary particle. The secondary particle properties. Secondary particles are particles that are emitted from an in-flight particle. The particle to spawn upon the particle death. Updates instance related state for secondary particles based on the given parent particle instance The parent IParticleInstance from which this secondary particle is being spawned Represents a particle that has been spawned Advances the physics simulation of the particle if "physicsSim.PhysicsTickTime" seconds have passed by, otherwise it will only advance PrevPosition by the particles velocity. Will never be above PhysicsTickTime A base class for all particle providers. Determines whether or not the particle dies in liquid Whether or not the particle dies in air. Gets the quantity of particles. Gets the position of particles. Gets the velocity of the particles. Gets the color of the particle. Gets the evolving opacity value of the particle. An evolving value based on opacity. Gets the evolving red value of the particle. Gets the evolving green value of the particle. Gets the evolving blue value of the particle. Gets the model type of the particle. gets the size of the particle. gets the dynamic size of the particle. Get the dynamic speeds of the particle. Gets the gravity effect on the particle. gets the life length of the particle. gets the glow level of the particle. Whether or not the particle is self-propelled. Whether or not the particle collides with the terrain or not. How the particle is written to the save. (if it is) How the particle is read from the save. Gets the secondary particle spawn interval. Gets the secondary particle type for this particle. Gets the death particle for this type of particle. A configurable implementation of IParticlePropertiesProvider The block which can be used to get a random color when particle spawns are send from the server to the client The item which can be used to get a random color when particle spawns are send from the server to the client The color map for climate color mapping. Leave null for no coloring by climate The color map for season color mapping. Leave null for no coloring by season The platform interface for various controls. Used by the game to handle various properties. Total disk space in bytes Total system ram in bytes The member ship level in this group The last known group name The group id A registerable object with variants, i.e. an item, a block or an entity A unique domain + code of the object. Must be globally unique for all items / all blocks / all entities. Variant values as resolved from blocktype/itemtype. NOT set for entities - use entity.Properties.VariantStrict instead. Variant values as resolved from blocktype/itemtype. Will not throw an null pointer exception when the key does not exist, but return null instead. NOT set for entities - use entity.Properties.Variant instead The class handeling the object Returns a new assetlocation with an equal domain and the given path Removes componentsToRemove parts from the blocks code end by splitting it up at every occurence of a dash ('-'). Right to left. Removes componentsToRemove parts from the blocks code beginning by splitting it up at every occurence of a dash ('-'). Left to Right Replaces the last parts from the blocks code and replaces it with components by splitting it up at every occurence of a dash ('-') More efficient version of CodeWithParts if there is only a single parameter Replaces one part from the blocks code and replaces it with components by splitting it up at every occurence of a dash ('-') Returns the n-th code part in inverse order. If the code contains no dash ('-') the whole code is returned. Returns null if posFromRight is too high. Returns the n-th code part. If the code contains no dash ('-') the whole code is returned. Returns null if posFromLeft is too high. Returns true if any given wildcard matches the blocks/items code. E.g. water-* will match all water blocks Returns true if given wildcard matches the blocks/items code. E.g. water-* will match all water blocks Returns true if any given wildcard matches the blocks/items code. E.g. water-* will match all water blocks Returns true if given wildcard matches the blocks/items code. E.g. water-* will match all water blocks Used by the block loader to replace wildcards with their final values Used by the block loader to replace wildcards with their final values Used by the block loader to replace wildcards with their final values Create a BitmapExternal from a byte array Retrives the ARGB value from given coordinate Retrives the ARGB value from given coordinate using normalized coordinates (0..1) an internal control containing the properties of a chat message. The UID of the player who sent the message. The message that was sent. The type of chat the message was sent as. A definition for the types of chat that could occur. A command was successful. A command failed. The message was sent to the player only. The message was sent from another player. The message was a notification (The world ends in 3 days, You cannot do this, ect) The message was sent to all the groups involved. The group has invited the player. The player has joined or left the group. There was a macro involved. A tag parser The currently parsed token, its attributes, and child elements The current font, you and push a new font if this tag modifies the current font or call .Peek() to get the current one Handler passed on by the displaying dialog that should be called if a user pressed a piece of text, if it is clickable at all You can register your own tag converters here Name of this tag Collection of attribute names and values for this tag Use this to create any dedicated thread (by default, IsBackground is true, but that can be changed by calling code)
This records the thread in the list of DedicatedThreads we maintain here, for stats purposes Reads a Json object, and converts it to the designated type. The designated type The json object. Converts the object to json. The type to convert The object to convert Converts a Json object to a typed object. The type to convert. The text to deserialize The domain of the text. The settings of the deserializer. (default: Null) Converts a Json token to a typed object. The type to convert. The token to deserialize The domain of the text. The settings of the deserializer. (default: Null) OldBlock param may be null! A custom itemstack render handler. This method is called after Collectible.OnBeforeRender(). For render target gui, the gui shader and its uniforms are already fully prepared, you may only call RenderMesh() and ignore the modelMat, position and size values - stack sizes however, are not covered by this. The slot in which the itemstack resides in The render info for this stack, you can choose to ignore these values The model transformation matrix with position and size already preapplied, you can choose to ignore this value The center x-position where the stack has to be rendered The center y-position where the stack has to be rendered The depth position. Higher values might be required for very large models, which can cause them to poke through dialogs in front of them, however The size of the stack that has to be rendered The requested color, usually always white Whether or not to rotate it (some parts of the game have this on or off) Whether or not to show the stack size (some parts of the game have this on or off) Return false to stop spawning particles Contains some client specific events you can hook into Called when a chat message was received Called before a chat message is sent to the server Called when a player joins. The Entity of the player might be null if out of range! Called whenever a player disconnects (timeout, leave, disconnect, kick, etc.). The Entity of the player might be null if out of range! Called when the player dies Fired when a player is ready to join but awaits any potential mod-user interaction, such as a character selection screen Called when a players entity got in range Called whenever a players got out of range When the game was paused/resumed (only in single player) When the player wants to leave the world to go back to the main menu When the player left the world to go back to the main menu When a player block has been modified. OldBlock param may be null! When player tries to modify a block Fired before a player changes their active slot (such as selected hotbar slot). Allows for the event to be cancelled depending on the return value. Note: Not called when the server forcefully changes active slot. Fired after a player changes their active slot (such as selected hotbar slot). Fired when something fires an ingame error Fired when something triggers a discovery event, such as the lore system Fired when the GuiColorsPreset client setting is changed, since meshes may need to be redrawn Registers a rendering handler to be called during every render frame If set, the frame profile will record the frame cost for this renderer Registers a rendering handler to be called during every render frame
Additionally reserves a range of render orders which no other renderer should then use Removes a previously registered rendering handler. Registers a custom itemstack renderer for given collectible object. If none is registered, the default renderer is used. For render target gui, the gui shader and its uniforms are already fully prepared, you may only call RenderMesh() and ignore the modelMat, position and size values - stack sizes however, are not covered by this. Removes a previously registered itemstack renderer Set up an asynchronous particle spawner. The async particle simulation does most of the work in a seperate thread and thus runs a lot faster, with the down side of not being exaclty in sync with player interactions. This method of spawning particles is best suited for ambient particles, such as rain fall. Fired when server assets were received and all texture atlases have been created, also all sounds loaded Fired when the player tries to reload the shaders (happens when graphics settings are changed) Called when textures got reloaded Called when the client received the level finalize packet from the server Called when shapes got reloaded Called when the hotkeys are changed Provides low level access to the mouse down event. If e.Handled is set to true, the event will not be handled by the game Provides low level access to the mouse up event. If e.Handled is set to true, the event will not be handled by the game Provides low level access to the mouse move event. If e.Handled is set to true, the event will not be handled by the game Provides low level access to the key down event. If e.Handled is set to true, the event will not be handled by the game Provides low level access to the key up event. If e.Handled is set to true, the event will not be handled by the game Fired when the user drags&drops a file into the game window The state of a network channel No such channel was registered This channel has been registered but he server did not send the server channel information yet This channel has been registered client and server side. It is ready to send and receive messages This channel has been registered only client side. You cannot send data on this channel API Features to set up a network channel for custom server<->client data exchange. Client side. Supplies you with your very own and personal network channel with which you can send packets to the server. Use the same channelName on the client and server to have them link up. Unique channel identifier Returns a previously registered channel, null otherwise Check in what state a channel currently is in Supplies you with your very own and personal network channel with which you can send packets to the server. Use the same channelName on the client and server to have them link up. Do not send larger messages then 508 bytes since some clients may be behind NAT/firwalls that may drop your packets if they get fragmented Unique channel identifier Returns a previously registered channel, null otherwise Sends a blockentity interaction packet to the server. For quick an easy blockentity network communication without setting up a channel first. Sends a blockentity interaction packet to the server. For quick an easy blockentity network communication without setting up a channel first. Sends a entity interaction packet to the server. For quick an easy entity network communication without setting up a channel first. Sends the players entity position (and Mount position) via UDP (if possible) to the server Sends a mount position via UDP (if possible) to the server Sends a blockentity interaction packet to the server. For quick an easy blockentity network communication without setting up a channel first. Sends a entity interaction packet to the server. For quick an easy entity network communication without setting up a channel first. Sends a entity interaction packet to the server. For quick an easy entity network communication without setting up a channel first. Sends given packet data to the server. This let's you mess with the raw network communication and fiddle with internal engine packets if you know the protocol. For normal network communication you probably want to register your own network channel. Sends given packet to server. For use with inventory supplied network packets only, since the packet format is not exposed to the api The network packet to send. Sends the current hand interaction. the current mouse button press the currently selected Block (if there is one) the currently selected Entity (if there is one) The state of the hand. Is it the first of this events for this block? (by default the client calls the interaction every second while the player holds down the right mouse button) The reason we cancelled the use of an item (if there is one) If any mod denies the client event IsPlayerReady, then it has to call this method once to indicate that the player is now ready to play (which switches the server side client state from Connected to Playing) Sends a blockentity interaction packet to the server. For quick an easy blockentity network communication without setting up a channel first. Uses Protobuf.net to serialize your data The channel name this channel was registered with Registers a handler for when you send a packet with given messageId Registers a handler for when you send a packet with given messageId Handler for processing a message Represent a custom network channel for sending messages between client and server True if the server is listening on this channel Registers a handler for when you send a packet with given messageId. Must be registered in the same order as on the server. Registers a handler for when you send a packet with given messageId. Must be registered in the same order as on the server. Registers a handler for when you send a packet with given messageId Sends a packet to the server A client side player The cameras current pitch The players current camera mode Writes given message to the players current chat group but doesn't send it to the server Tells the engine to run a first person animtion The world accessor implemented by the client, offers some extra features only available on the client Interface to access the game calendar Loads the rgb climate and season color map value at given position and multiplies it byte-wise with supplied color Loads the rgb climate and season color map value for given rain and temp value and multiplies it byte-wise with supplied color Whether the player can select liquids Whether to spawn ambient particles Returns the player running this client instance Loads a sounds without playing it. Use to individually control when to play/stop. Might want to set DisposeOnFinish to false but then you have to dispose it yourself. Shakes the camera view by given strength Same effect as when player left-click breaks a block, but will not cause actual breakage of the block Applies the same damage overlay effect on the target as the source has Makes an attempt to attack a particular entity. The internal cache of all currently loaded entities. Warning: You should not set or remove anything from this dic unless you *really* know what you're doing. Use SpawnEntity/DespawnEntity instead. Gets the MapSizeY on the client, for chunk column enumeration, without this this is surprisingly hard to get... Exactly like PlaySoundAt except that it returns the duration of the played sound. (We don't want to change the method signature of PlaySoundAt for API mod breakage reasons) Does exactly what it says on the tin! Facilitates the Accessibility tab wireframe colors setting. Offers three preset color options, "Default", "Preset2" and "Preset3". The selection between these three options is chosen by the ClientSettings int value "guiColorsPreset". Within these presets, individual color values are stored by string key. Mods (e.g. VSSurvivalMod) can call this to insert into the presets their configured color keys and values, which will be specific to mod content To be called when the ClientSetting "guiColorsPreset" is changed Called to fetch a color value from the currently selected preset colors The core api implemented by the client. The main interface for accessing the client. Contains all sub components and some miscellaneous methods. Add your own link protocol here if you want to implement a custom protocol. E.g. image://url-to-picture Add your own rich text elements here. Your will need to convert a VTML tag into a RichTextComponentBase element. The clients game settings as stored in the clientsettings.json Platform independent ui methods and features. Api to the client side macros system Amount of milliseconds ellapsed since client startup Amount of milliseconds ellapsed while in a running game that is not paused True if the client is currently in the process of exiting True if the game is currently paused (only available in singleplayer) True if this is a singleplayer session If true, the player is in gui-less mode (through the F4 key) True if all SendPlayerNowReady() was sent, signalling the player is now ready (called by the character selector upon submit) API Component to control the clients ambient values API Component for registering to various Events API for Rendering stuff onto the screen using OpenGL API for GUI Related methods API for Mouse / Keyboard input related things Holds the default meshes of all blocks API for Meshing in the Mainthread. Thread safe. API for the Block Texture Atlas API for the Item Texture Atlas API for the Entity Texture Atlas Fetch color configs, used for accessibility e.g. for knapping wireframe gridlines API for Rendering stuff onto the screen using OpenGL API for doing sending/receiving network packets API for accessing anything in the game world Active GUI objects. Registers a chat command Registers a chat command Registers an entity renderer for given entity Register a link protocol handler Shows a client side only chat message in the current chat channel. Uses the same code paths a server => client message takes. Does not execute client commands. Triggers a discovery event. HudDiscoveryMessage registers to this event and fades in/out a "discovery message" on the players screen Triggers an in-game-error event. HudIngameError registers to this event and shows a vibrating red text on the players screen Same as but will also execute client commands if they are prefixed with a dot. Sends a chat message to the server Sends a chat message to the server in the players currently active channel Tells the music engine to load and immediately start given track once loaded, if the priority is higher than the currently playing track. May also be stopped while playing if another track with a higher priority is started. If you supply an onLoaded method the track is not started immediately and you can manually start it at any given time by calling sound.Start() Returns the currently playing music track, if any is playing Just a default gpu-uploaded quad for 2d texture rendering, for your convenience List of all registered guis List of all currently opened guis A utility class that does text texture generation for you A utlity class that helps draw text A utility class that contains a bunch of hardcoded icons Returns a ElementBounds that is always the size of the game window If there is a currenly opened dialog or hud element, the method will return the bounds occuppying that area, otherwise null Creates a new gui composition Register given dialog(s) to the gui/input event listening chain. You only need to call this if your dialog has to listen to events even while closed. The method GuiDialog.TryOpen() also does the register if not registered already. Removes given texture from graphics card memory Loads an external .svg file into a texture. Will return null if the file is not found Loads an external .svg file into a texture. Will return null if the file is not found Load the contents of a cairo surface into a opengl texture. Returns the texture id Load the contents of a cairo surface into a opengl texture. Re-uses the supplied texture exists and the size is correct. Otherwise deletes the texture and regenerates it. Retrieve the saved dialog position from settings Remember the dialog position for given dialog key Plays a sound, non location specific The name of the sound If true, the pitch is slightly randomized each time Plays a sound, non location specific. The name of the sound If true, the pitch is slightly randomized each time Requests the given GUI to be given focus. The dialogue wanting attention. Triggers the opening of a dialogue. The dialogue to be opened. Triggers the closing of a dialogue. The dialogue to be closed. Opens up a confirm dialog asking the player if he wants to open an external link This interface manages the inputs of the player and is used mostly on the client side. Get set clipboard text Triggered when the player attempts to trigger an action, such as walking forward or sprinting The current keyboard key states, use the enum to get the index of an array key. The current keyboard key states that were not handled by a dialog or other client systems (exception: hotkeys), use the enum to get the array index of a key. The current mouse button state The current mouse button state outside of dialogs / clicked inside the game world The current x-position of the mouse, relative to the upper left corner of the game window The current y-position of the mouse, relative to the upper left corner of the game window When controlling the camera, this is the camera yaw determined by the game engine When controlling the camera, this is the camera pitch determined by the game engine Handles the event when the mouse enters the bounding box of the given item slot. The slot of the item. Part of a group of things that will be moved to an event bus at some point. Handles the event when the mouse leaves the bounding box of the given item slot. The slot of the item Part of a group of things that will be moved to an event bus at some point. Handles the event when the mouse clicks on a given item slot. The slot of the item Part of a group of things that will be moved to an event bus at some point. Gives the player the ability to still interact with the world even if a gui dialog is opened True if the mouse cursor is currently grabbed and not visible. (Such as while controlling the character's view in first person.) Registers a hot key with given default key combination, the player will be able change these in the controls. Supplied hotkeyCode can than be used to register a hotkey handler. Same as RegisterHotKey except it inserts it at the start of the list Will call the handler if given hotkey has been pressed. Removes the previously assigned handler. Returns a list of all currently registered hotkeys. Gets the hotkey by the given hotkey code. the key combination code. The registered hotkey. The main api component to assist you in rendering pretty stuff onto the screen List of all loaded frame buffers. To get the god rays frame buffer for exampple, do Framebuffers[(int)EnumFrameBuffer.GodRays] Set the current framebuffer A number of default shader uniforms Can be used to offset the position of the player camera The render stage the engine is currently at The default view matrix used during perspective rendering. Is refreshed before EnumRenderStage.Opaque. Useful for doing projections in the Ortho stage via MatrixToolsd.Project() The default projection matrix used during perspective rendering. Is refreshed before EnumRenderStage.Opaque. Useful for doing projections in the Ortho stage via MatrixToolsd.Project() The name of the font used during this render (if it exists). The standard font used during this render (if it exists). Width of the primary render framebuffer Height of the primary render framebuffer The desired camera type. Be aware, the actual camera type can change at runtime if the player is against a wall and tries to look from inside the wall - use entityPlayer.CameraMode to get the actual mode True if when in IFP mode the camera would end up inside blocks The current modelview matrix stack The current projection matrix stack Returns you a render info object of given item stack. Can be used to render held items onto a creature. Returns null if no OpenGL Error happened, otherwise one of the official opengl error codes If opengl debug mode is enabled and an opengl error is found this method will throw an exception. It is recommended to use this methods in a few spots during render code to track down rendering issues in time. The current model view. Pushes a copy of the current matrix onto the games matrix stack Pops the top most matrix from the games matrix stack Replaces the top most matrix with given one Translates top most matrix in the games matrix stack Translates top most matrix in the games matrix stack Scales top most matrix in the games matrix stack Rotates top most matrix in the games matrix stack Enables the Culling faces. Disables the culling faces. Enables the Depth Test. Disables the Depth Test. Toggle writing to the depth buffer Regenerates the mip maps for the currently bound texture To enable/disable various blending modes The current top most matrix in the model view matrix stack. Player camera matrix with player positioned at 0,0,0. You can use this matrix instead of for high precision rendering. Player camera matrix with player positioned at 0,0,0. You can use this matrix instead of for high precision rendering. The current top most matrix in the projection matrix stack The current projection matrix for shadow rendering (renders the scene from the viewpoint of the sun) Convenience method for GlScissor(). Tells the graphics card to not render anything outside supplied bounds. Can be turned of again with PopScissor(). Any previously applied scissor will be restored after calling PopScissor(). If true, also applies scissoring from the previous call to PushScissor, otherwise replaces the scissor bounds End scissor mode. Disable any previously set render constraints Tells the graphics card to not render anything outside supplied bounds. Only sets the boundaries. Can be turned on/off with GlScissorFlag(true/false) Whether scissor mode should be active or not Creates a bitmap from a given PNG. the PNG data passed in. A bitmap object. Loads texture from Pixels in BGRA format. The pixel array the width of the final texture the height of the final texture Enable/Disable Linear rendering or use Nearest rendering. The current clamp mode The GLID for the resulting texture. Loads texture from Pixels in RGBA format. The pixel array the width of the final texture the height of the final texture Enable/Disable Linear rendering or use Nearest rendering. The current clamp mode The OpenGL Identifier for the resulting texture. Loads texture from Pixels in BGRA format. The pixel array Enable/Disable Linear rendering or use Nearest rendering. The current clamp mode The target texture space it should load the pixels into. Must have width/height set accordingly. Will set the opengl textureid upon successful load Loads texture from Pixels in RGBA format. The pixel array Enable/Disable Linear rendering or use Nearest rendering. The current clamp mode The target texture space it should load the pixels into. Must have width/height set accordingly. Will set the opengl textureid upon successful load. Deletes given texture the OpenGL Identifier for the target Texture. Max size a texture can have on the current graphics card The maximum size a texture can have on the current graphics card in Pixels. Binds given texture. For use with shaders - you should assign the texture directly though shader uniforms. The OpenGL Identifier ID for the target texture to bind. Loads given texture through the assets managers and loads it onto the graphics card. Will return a cached version on every subsequent call to this method. the location of the texture as it exists within the game or mod directory. The texture id Loads given texture through the assets managers and loads it onto the graphics card. Will return a cached version on every subsequent call to this method. the location of the texture as it exists within the game or mod directory. the texture object to be populated. If it already is populated it will be disposed first Loads the texture supplied by the bitmap, uploads it to the graphics card and keeps a cached version under given name. Will return that cached version on every subsequent call to this method. the location of the texture as it exists within the game or mod directory. The referenced bitmap the texture object to be populated. If it already is populated it will be disposed first Removes given texture from the cache and from graphics card memory the location of the texture as it exists within the game or mod directory. whether the operation was successful or not. Gets you the uniform location of given uniform for given shader Gives you access to all of the vanilla shaders Gives you access to all currently registered shaders identified by their number Gives you a reference to the "standard" shader, a general purpose shader for normal shading work Populates the uniforms and light values for given positions and calls shader.Use(). The position for light level reading The position for light level reading The position for light level reading Gives you a reference to the currently active shader, or null if none is active right now Allocates memory on the graphics card. Can use UpdateMesh() to populate it with data. The custom mesh data parts may be null. Sizes are in bytes. the squared size of the texture. the size of the normals the size of the UV map. size of the RGBA colors. Size of the render flags. Size of the indices Float values of the mesh Float values of the mesh Byte values of the mesh The current draw mode whether the draw should be static or dynamic. the reference to the mesh Uploads your mesh onto the graphics card for rendering (= load into a VAO).

If you use a custom shader, these are the VBO locations: xyz=0, uv=1, rgba=2, rgba2=3, flags=4, customFloats=5, customInts=6, customBytes=7 (indices do not get their own data location)
If any of them are null, the vbo location is not consumed and all used location numbers shift by -1 Same as but splits it into multiple MeshRefs, one for each texture Updates the existing mesh. Updates any non null data from Updates the existing mesh. Updates any non null data from . Version for chunks only (also decals, as they use chunk MeshDataPool system) Frees up the memory on the graphics card. Should always be called at the end of a meshes lifetime to prevent memory leaks. Equivalent to calling Dispose on the meshref itself Renders given mesh onto the screen Renders given mesh onto the screen, with the mesh requiring multiple render calls for each texture, asigns the associated texture each call Uses the graphics instanced rendering methods to efficiently render the same mesh multiple times. Use the custom mesh data parts with instanced flag on to supply custom data to each mesh. Draws only a part of the mesh Renders given texture into another texture. If you use the resulting texture for in-world rendering, remember to recreate the mipmaps via If below given threshold, the pixel is not drawn into the target texture. (Default: 0.05) Renders given itemstack at given position (gui/orthographic mode) Set to for normal rendering Unused. If true, will slowly rotate the itemstack around the Y-Axis If true, will render a number depicting how many blocks/item are in the stack Renders given itemstack in slot at given position (gui/orthographic mode) Renders given itemstack in slot at given position (gui/orthographic mode) Renders given itemstack into supplied texture atlas. This is a rather costly operation. Also be sure to cache the results, as each call to this method consumes more space in your texture atlas. If you call this method outside the ortho render stage, it will enqueue a render task for next frame. Rather exceptionally, this method is also thread safe. If called from another thread, the render task always gets enqueued. The call back will always be run on the main thread. Once rendered, this returns a texture subid, which you can use to retrieve the textureAtlasPosition from the atlas True if the render could complete immediatly, false if it has to wait until the next ortho render stage Returns the first TextureAtlasPosition it can find for given block or item texture in itemstack. Renders given entity at given position (gui/orthographic mode) For rotating the entity around its y-axis Renders given texture onto the screen, uses a simple quad for rendering (gui mode). Assumes the texture to use a premultiplied alpha channel Renders given texture onto the screen, uses a simple quad for rendering (gui mode). Assumes the texture to use a premultiplied alpha channel Renders given texture onto the screen, uses a simple quad for rendering (gui mode). Assumes the texture to use a premultiplied alpha channel Renders given texture onto the screen, uses a simple quad for rendering (gui mode) Renders given texture onto the screen, uses a simple quad for rendering (gui mode) Renders given texture onto the screen, uses supplied quad for rendering (gui mode) Renders given texture onto the screen, uses supplied quad for rendering (gui mode) Renders given texture onto the screen, uses a simple quad for rendering (gui mode) Renders given texture onto the screen, uses a simple quad for rendering (gui mode) Renders a rectangle outline at given position Inefficiently renders a line between 2 points The current ambient color (e.g. will return a blue tint when player is under water) The current fog color (e.g. will return a blue tint when player is under water) Current minimum fog value Density of the current fog. Fog is calculated as followed in the shaders: clamp(fogMin + 1 - 1 / exp(gl_FragDepth * fogDensity), 0, 1) If true, chunk rendering will use SSBOs - a OpenGL 4.30+ feature - for higher performance in game version 1.21+ Adds a dynamic light source to the scene. Will not be rendered if the current point light count exceeds max dynamic lights in the graphics settings Removes a dynamic light source from the scene Interface to render something on to the clients screens. Used for block entitites. 0 = drawn first, 1 = drawn last
Default render orders by render stage:
Before:
0 = Ambient Manager
0 = Camera

Opaque:
0.1 = Blue sky (Icosahedron)
0.2 = Night skybox
0.3 = Sun and moon
0.37 = Terrain opaque
0.4 = Enitities
0.5 = Decals
0.5 = Debug wireframe
0.6 = particles
0.7 = Cinematic camera line preview
0.8 = fp held item
0.9 = held item opaque custom renderer

OIT:
0.2 = Frame buffer debug screen
0.35 = Clouds
0.37 = Terrain oit
0.4 = Enitities
0.6 = particles
0.9 = held item oit custom renderer

Shadow far:
0 = shadow map init
0.37 = Terrain shadow far
0.4 = Enitities

Shadow far done:
1 = shadow map finish

Shadow near:
0 = shadow map init
0.37 = Terrain shadow near
0.4 = Enitities

Shadow near done:
1 = shadow map finish
Ortho:
0.2 = Frame buffer debug screen
0.4 = Enitities
0.9 = held item ortho custom renderer
0.95 = sleeping overlay
0.98 = bow/spear aiming reticle
1 = Gui manager
1.02 = crosshair and mouse cursor

AfterFinalComposition:
2 = screenshot

Done:
0.1 = gui manager
2 = screenshot

0.98 = Cinematic camera camera advancing and frame capture when recording
0.99 = Chunk Tesselator Manager (uploads new/modified chunk meshes)
0.999 = Compress chunks scan
1 = video recorder
 Within what range to the player OnRenderFrame() should be called (currently not used!) Called every frame for rendering whatever you need to render Setting interface. The type of the given setting. Gets and sets the setting with the provided key. The key to the setting. The current value of the given key. Gets the setting with the provided key Sets the setting with key to the provided value: if shouldTriggerWatchers is false, the watchers will not be triggered Does this setting exist? The key to check on a setting. Whether the setting exists or not. Setting watcher for changes in values for a given setting. Key to the setting the OnValueChanged event fired. Removes a previously assigned watcher True if successfully removed Setting interface for multiple settings. Setting collection for boolean values. Setting collection for integer values. Setting collection for float values. Setting collection for string values. Setting collection for string list values. Setting watcher for changes in values for a given setting. The type of the value that was changed. Key to the setting the OnValueChanged event fired. API for configuring and loading GLSL Shaders Returns an empty instance of an IShaderProgram for you to configure. Once configured, call RegisterShaderProgram Returns an empty instance of an IShader for you to configure as vertex, fragment or geometry shader Registers a configured IShaderProgram. The name must correspond to the .vsh and .fsh filenames (without ending). Returns a program number to be used in UseShaderProgram() Registers a configured IShaderProgram. Will not load anything from the shaders folder. Returns a program number to be used in UseShaderProgram() Returns the loaded shader for use in rendering Returns the loaded shader for use in rendering Discards all currently compiled shaders and recompiles them. Returns true if all shaders compiled without errors. Returns true if given GLSL Version is available on this machine For performance, used to limit what height gets rendered on transparent textures of plants such as tallgrass and flowers Manager interface for Tesselators. Returns the default block mesh that being used by the engine when tesselating a chunk. The alternate and inventory versions are seperate. Returns the default block mesh ref that being used by the engine when rendering a block in the inventory. The alternate and inventory versions are seperate. Returns the default block mesh ref that being used by the engine when rendering an item in the inventory. The alternate and inventory versions are seperate. Interface that allows custom model model meshing for items, blocks and entities
Texturing crash course:
1. Block, Item and Entity textures are loaded from json files in the form of a CompositeTexture instance
2. After connecting to a game server, the client inserts all of these textures into their type-respective texture atlasses
3. After insertion a "texture sub-id" is left behind in the CompositeTexture.Baked Property
4. You can now find the position of the texture inside the atlas through the Block/Item/Entity-TextureAtlasPositions arrays (teturesubid is the array key)

Shape Tesselation crash course:
1. Block and Item shapes are loaded from json files in the form of a CompositeShape instance
2. A CompositeShape instance hold some block/item specific information as well as an identifier to a Shape instance
4. After connecting to a game server, the client loads all shapes from the shape folder then finds each blocks/items shape by its shape identifier
5. Result is a MeshData instance that holds all vertices, UV coords, colors and etc. for each block
6. That meshdata instance is
a) Held as-is in memory for using during chunk tesselation (you can get a reference to it through getDefaultBlockMesh())
b) "Compiled" to a Model for use during rendering in the gui.
Model Compilation means all it's mesh data is uploaded onto the graphcis through a VAO and a ModelRef instance is left behind which
can be used by the RenderAPI to render it. Tesselates a block for you using given blocks shape and texture configuration Tesselates an item for you using given items shape and texture configuration Tesselates an item for you using given items shape and texture configuration Tesselates an item for you using the items shape and your own defined texture configuration. You need to implement the ITextureSource yourself. Tesselate a shape based on its composite shape file Turns a shape into a mesh data object that you can feed into the chunk tesselator or upload to the graphics card for rendering. Uses the given collectible texture configuration as texture source. Turns a shape into a mesh data object that you can feed into the chunk tesselator or upload to the graphics card for rendering. Can be used to supply a custom texture source. Turns a shape into a mesh data object that you can feed into the chunk tesselator or upload to the graphics card for rendering. Can be used to supply a custom texture source. Will add a customints array to the meshdata that holds each elements JointId for all its vertices (you will have to manually set the jointid for each element though) Turns a shape into a mesh data object that you can feed into the chunk tesselator or upload to the graphics card for rendering. Can be used to supply a custom texture source. Will add a customints array to the meshdata that holds each elements JointId for all its vertices (you will have to manually set the jointid for each element though) A helper method that turns a flat texture into its 1-voxel thick voxelized form A helper method that turns a flat texture into its 1-voxel thick voxelized form Returns the texture source from given block. This can be used to obtain the positions of the textures in the block texture atlas. Returns the texture source from given item. This can be used to obtain the positions of the textures in the item texture atlas. Returns the texture source from given entity. This can be used to obtain the positions of the textures in the entity texture atlas. Item texture Atlas. Returns the position in the item texture atlas of given item. For items that don't use custom shapes you don't have to supply the textureName Block texture Atlas Returns the position in the block texture atlas of given block. Entity texture Atlas. Texture atlas base. The texture atlas position of the "unknown.png" texture Size of one block texture atlas As configured in the clientsettings.json divided by the texture atlas size Returns the default texture atlas position for all blocks, referenced by the texturesubid Returns the list of currently loaded texture atlas ids Reserves a spot on the texture atlas. Returns true if allocation was successful. Can be used to render onto it through the Render API If set, said texture space can be looked up by the tesselated element faces during shape tesselation Inserts a texture into the texture atlas after the atlas has been generated. Updates the in-ram texture atlas as well as the in-gpu-ram texture atlas. The textureSubId can be used to find the TextureAtlasPosition again in case you loose it ;-) Inserts a texture into the texture atlas after the atlas has been generated. Updates the in-ram texture atlas as well as the in-gpu-ram texture atlas. The textureSubId can be used to find the TextureAtlasPosition again in case you loose it ;-) Loads a bitmap from given asset. Can use ++ syntax for texture overlay and @[int] for texture rotation Same as but this method remembers the inserted texure, which you can access using capi.TextureAtlas[path] A subsequent call to this method will update the texture, but retain the same texPos. Also a run-time texture reload will reload this texture automatically. Used as reference for caching The method that should load the bitmap, if required. Can be left null to simply attempt to load the bmp from using method False if the file was not found or the insert failed Same as but this method remembers the inserted texure, which you can access using capi.TextureAtlas[path] A subsequent call to this method will update the texture, but retain the same texPos. Also a run-time texture reload will reload this texture automatically. Used as reference for caching The method that should load the bitmap, if required. Can be left null to simply attempt to load the bmp from using method False if the file was not found or the insert failed Same as but this method remembers the inserted texure, which you can access using capi.TextureAtlas[path] A subsequent call to this method will update the texture, but retain the same texPos. Also a run-time texture reload will reload this texture automatically. Same as but this method remembers the inserted texure, which you can access using capi.TextureAtlas[path] A subsequent call to this method will update the texture, but retain the same texPos. Also a run-time texture reload will reload this texture automatically. Deallocates a previously allocated texture space Deallocates a previously allocated texture space Returns an rgba value picked randomly inside the given texture (defined by its sub-id) Regenerates the mipmaps for one of the atlas textures, given by its array index Returns one of 30 random rgba values inside the given texture (defined by its sub-id) 0..29 for a specific random pixel, or -1 to randomize, which is the same as calling GetRandomColor without the rndIndex argument Returns one of 30 random rgba values inside the given texture (defined by its sub-id) 0..29 for a specific random pixel, or -1 to randomize, which is the same as calling GetRandomColor without the rndIndex argument Get the random colors array for the specified TextureAtlasPosition, creating it if necessary Returns you an average rgba value picked inside the texture subid Renders given texture into the texture atlas at given location A reference to a mesh that's been uploaded onto the graphics card (i.e. that has been placed in an OpenGL VAO). This reference can be used for rendering it. Am I disposed? Frees up any gpu allocated memory. Equivalent to calling api.Render.DeleteMesh() Am I disposed? Size in Bytes Frees up any gpu allocated memory. Equivalent to calling api.Render.DeleteMesh() A world interaction for the object. This is used to prompt the player about what a certain object can do. What mouse button should be used for this interaction? Does it require a mouse modifier key to perform this action (e.g. "shift" or "ctrl") Does it require pressing multiple keys to perform this action (if set then HotkeyCode is ignored) The text to show, will be used in the form of Lang.Get(ActionLangCode); Does the player need to hold a certain items/blocks in hands? (e.g. a knife). You can define an array of item stacks here and the game will loop through them in a 1 second interval. This property is loaded from the entitytypes and blocktype json files and then resolved. If true, the interaction only applies when the player has no slot in hands Only applicable when ItemStacks is non null. If set, this method will be executed before adding the interaction. Lets you return a filtered list of itemstacks that can be used for this interaction (or null/empty array for not interactable) Only applicable when ItemStacks is null. If set and the method returns false, the interaction will not be displayed Represent a dynamically composed track made out of individual small pieces of music mixed together defined by specific rules Requirements: - Start/Stop Multiple Trackpieces - Set their volumne dynamically - Decide which Trackpieces to play - Allow individual rules per Trackpiece Specific examples: - Play Thunder ambient only if thunderlevel above 10 - Thunder ambient volume based on thunderlevel (between 0.3 and 1.1?) - Play Aquatic Drone only when y below 60 - Play Deep Drone only when y below 50 The name of the music track. When playing cave sounds, play between 4-10 minutes each time Is the track active? The priority of the track. Initializes the music track the global Asset Manager The Core Client API Should the game play this track? The properties of the current track. Do we play this track? Starts playing the track. The properties of the current track. Do we continue playing this track? Delta time or Change in time The properties of the current track. Are we still playing or do we stop? Fade out the track to end. Seconds to fade out across. Delegate to have happen once the fade-out is done. Updates the volume of the track. Represents a loaded game sound Length of the sound in seconds Get the current playback position or set it (in seconds) Is the sound disposed of? Is sound currently playing True if the track is fading to a higher volume True if the track is fading to a lower volume Is the sound finished with playing? (false when only paused) Amount of audio channels this sound has The params the sound was created with. Starts the sound Stops the sound Pauses the sound True for Starting, False for Stopping the sound Allows you to modify the pitch of the sound. May also be called while the sound is currently playing. Allows you to modify the pitch of the sound. May also be called while the sound is currently playing. This value is added together with the normal pitch level. This method is currently used to distort sound during low temporal stability Allows you to modify the volumne of the sound. May also be called while the sound is currently playing. Sets the current volumne again. Use this to update the sounds volumne after the global sound level has changed Sets the position from where the sound is originating from Fades the sounds volumne to given value Called when the fade has completed. If in the meantime another FadeXXX call has been made, the method is not called Causes the sound to fade out Called when the fade out has completed. If in the meantime another FadeXXX call has been made, the method is not called Causes the sound to fade in Called when the fade in has completed. If in the meantime another FadeXXX call has been made, the method is not called Causes the sound to fade out and stop the track Loads the sound into memory and plays the track. Slow call. Encapsulate it into ThreadPool.QueueUserWorkItem() to not block the main thread The currently playing track The track that played before The total passed milliseconds since game start at the point where the last track stopped playing The name of the track Is the track active? The priority of the track. A higher priority will cancel active tracks. The start priority of the track. A higher priority will leave active tracks playing. Called before sorting by start priority happens Initialization of the Music Track. the global Asset Manager The Core Client API Should this current track play? Player Properties Should we play the current track? Begin playing the current track. Player Properties Is it cool for the current track to continue playing? Delta Time/Change in time. Track properties. Cool or not cool? Updates the volume on the current track. Called when the track to interupted or when Update() returned false. So called every time the tracked ended or has to end Adds a basic music track. Is it loading? Get the current sound file. Is the current song actively playing or is it loading? (False if neither action. The current song's priority. The name of the track. Core client API. If true, the music is considered active/playing until set to false and so no other track will play Stops the track immediately Initialize the track. the global Asset Manager The Core Client API Should this current track play? Player Properties Should we play the current track? Begins playing the Music track. Player Properties Is it cool for the current track to continue playing? Delta Time/Change in time. Track properties. Cool or not cool? Fades out the current track. The duration of the fade out in seconds. What to have happen after the track has faded out. Updates the volume of the current track provided Sound is not null. (effectively calls Sound.SetVolume) The minimum Suitability of the given track The maximum Suitability of the given track The minimum volume of a given track. The maximum volume of a given track. the Y position. The files for the part. The loaded sound Start time in Miliseconds Am I loading? Am I playing? Am I applicable? world information the properties of the current track. The current volume of the track. world information the properties of the current track. The current Suitability of the track. world information the properties of the current track. Expands the target files. The current AssetManager instance. Creates a track for rain related music. [Not yet implemented] Sound types, often used to determine specific volume controls. The sound paramaters used for loading sounds on the client side The specific sound to be played The position of the sound If true then Position is added relative to the players current position If the sound should start again when finished Probably want to set this to false on looping sounds. But remember to dispose it yourself when you no longer need it The sounds intial pitch. 0...1 0...99f The range in which the sound does not attenuate at all The sounds initial volumne (0f - 1f) The sounds initial range (default is 32) Determines whether to apply the music or sound volumne level to the Volume Empty Constructor. Constructs the sound based off the asset location. The asset location of the track. Adds a basic music track. The location of the track. The current play style of the track Minimum sunlight to play the track. Earliest to play the track. Latest to play the track. The current song's priority. If higher than 1, will stop other tracks and start this one The songs starting priority. If higher than 1, then it will be started first. But does not interrupt already running tracks. When reading a songs start priority the maximum of start priority and priority is used Is it loading? Get the current sound file. Is the current song actively playing or is it loading? (False if neither action. The name of the track. The music seed for random values. Cooldowns between songs. First value is the minimum delay, second value is added randomness. (in seconds) Time before we play the same song again. First value is the minimum delay, second value is added randomness. (in seconds) Is this track initialized? Global cooldown until next track Cooldown for each track by name. Core client API. Gets the previous frequency setting. Gets the current Music Frequency setting. Initialize the track. the global Asset Manager The Core Client API The Frequency change in the static system. The new frequency the core client API Should this current track play? Player Properties Should we play the current track? Begins playing the Music track. Player Properties Is it cool for the current track to continue playing? Delta Time/Change in time. Track properties. Cool or not cool? Fades out the current track. The duration of the fade out in seconds. What to have happen after the track has faded out. Sets the cooldown of the current track. The multiplier for the cooldown. Updates the volume of the current track provided Sound is not null. (effectively calls Sound.SetVolume) Converts the given key to a string. the key being passed in. the string name of the key. Gets the string the key would produce upon pressing it without considering any modifiers (but single keys get converted to uppercase). So GlKeys.W on QWERTY Keyboard layout returns W, GlKeys.Space returns Space etc. Returns the printable character for a key. Does return null on none printable keys like Converts key code from OpenTK 4 to GlKeys Internally the game uses OpenTK and their Keys are by default mapped to US QWERTY Keyboard layout which the GlKeys also do. Upon typing text in a Text input field it will produce the correct characters according to your keyboard layout. If you need to get the character for the current Keyboard layout use Help and overlays that are always available (survival and creative mode) Mouse modifiers (i.e. for Shift- and Ctrl- click) Controls that are always available (survival and creative mode) Controls that control the players movement. Only available when the player not currently inside a dialog. Controls that control the players actions. Only triggered when the player not currently inside a dialog. Shortcuts for inventory actions. Controls that are only available in creative mode Controls that are only available in creative or spectator mode Developer tools Primary mouse controls For global hotkeys that shall not be blocked by anything (e.g. F11 for fullscreen, F12 for screenshot) For hotkeys that only available during a game session. When the game session ends, the handler to this hotkey is removed (or we have a dead reference to runninggame) The current key combination for this hotkey The default key combination for this hotkey The code of the Hotkey. The name of the Hotkey The type of the key combination. This defaults to HotkeyType.CharacterControls. This is the action that happens when the hotkey is used. If true, the handler will be called twice, once on the key or button down event, and once on the up event Was this hotkey pressed? Event arguments for the given key. The current world for the key. The player that pressed the buttons. Do we allow character control functions. If the hotkey was pressed or not. If this hotkey is a mouse control (primary or secondary mouse click), and this hotkey does not specifically require modifiers, then let's ignore modifiers when matching, because Shift+click or Ctrl+click is common; Alt+click might be used if Alt is being held Fallback version of the DidPress event. Event arguments for the given key. The current world for the key. The player that pressed the buttons. Do we allow character control functions. If the hotkey was pressed or not. Clones the hotkey. the cloned hotkey. Sets the default keymap for this hotkey. Mapping of an input key combination. Note: the "key" might also be a mouse button if a hotkey has been configured to be activated by a mouse button The first keycode representing a mouse button The KeyCode (from 1.19.4, the keycodes map to either keys or mouse buttons) The second key code (if it exists). Ctrl pressed condition. Alt pressed condition. Shift pressed condition. Converts this key combination into a string. The string code for this Key Combination. Clones the current key combination. The cloned key combination. the character for the given key. The keycode value. If a player taps in quick succession, this is the second key Is this keypress/key combination handled? Is control/Ctrl being held down? Is mac os command key being held down? Is Shift being held down? Is Alt being held down? This contains the data for what the mouse is currently doing. Current X position of the mouse. Current Y position of the mouse. The X movement of the mouse. The Y movement of the mouse. Gets the current mouse button pressed. Am I handled? This is apparently used for mouse move events (set to true if the mouse state has changed during constant polling, set to false if the move event came from opentk. This emulated state is apparantly used to determine the correct delta position to turn the camera. The event arguments for the mouse. The rough change in time since last called. The precise change in time since last called. The rough change in value. The precise change in value. Is the current event being handled? Changes or sets the current handled state. Should the event be handled? This is a modeldata pool, which can hold 400k vertices, 300k indices but not more than 900 chunks The maximum parts for this pool. The current vertices for this pool. the amount of indicies for this pool. The starting byte for each index. The size of each index. How many index groups are there. the position of the indices. the position of the vertices. The current fragmentaton. How many of the vertices are used. How many triangles are rendered. How many triangles are allocated. Allocates a new pool for mesh data. The core client API The vertices pool size. The index pool size. The maximum parts per pool. The custom floats of the pool. The custom bytes of the pool. The custom ints of the pool. The resulting mesh data pool. Attempts to add the new model. The core client API The model to add The origin point of the model. The culling sphere. The location of the model (and the data) in the pool. Attempts to remove the model from the pool if the model exists. Will throw an invalid call or an InvalidOperationException if used improperly. The location of the model data. Draw the model. The core client API The area where models can be viewed from the camera. The mode of the culling. Cleans up the rendering view of the models. The area where models can be viewed from the camera. The mode of the culling. Is this an empty pool. true if the pool is empty. Disposes of the current mesh pool. The core client API Calculates the current fragmentation of the mesh. Gets the current fragmentation of the pool. Contains all the data for the given model pool. The ID of the pool model. Where the indices of the model start. Where the indices of the model end. Where the vertices start. Where the vertices end. The culling sphere. Whether this model is visible or not. Used for models with movements (like a door). Holds a collection of pools, usually for 1 render pass Creates a new Mesh Data Pool The master mesh data pool manager the Frustum Culler for the Pool The Client API Size allocated for the Vertices. Size allocated for the Indices The maximum number of parts for this pool. Additional float data Additional byte data additional int data Adds a model to the mesh pool. The model data The origin point of the Model The culling sphere. The location identifier for the pooled model. Renders the chunk models to the GPU. One of the most important methods in the entire game! The position of the Player The culling mode. Default is CulHideDelay. Gets the stats of the model. The amount of memory used by this pool. The number of Tris rendered by this pool. The number of tris allocated by this pool. Holds all chunk mesh pools of the current running game If true, RemoveLocation() only actually removes the location after 3 frames. Need to call OnFrame() to achieve that Initializes the master mesh data pool. The Client API. Removes the models with the given locations. The locations of the model data. Adds a new pool to the master pool. The mesh data pool to add. Cleans up and gets rid of all the pools. The client API. Calculates the fragmentation. The resulting calculation. The number of model pools in this master manager. The number of model pools This is a recycling system for MeshData objects, so that they can be re-used: helps performance by easing memory allocation pressure, at the cost of holding typically around 300-400MB of memory for these recycled objects Gets or creates a MeshData with basic data fields already allocated (may contain junk data) and capacity (VerticesMax) at least equal to minimumVertices; in MeshData created/recycled using this system, IndicesMax will be fixed equal to VerticesMax * 6 / 4 Call this periodically on the same thread which will call GetOrCreateMesh, this is required to ensure the Recycling system is up to date Offer this MeshData to the recycling system: it will first be queued for recycling, and later processed to be either recycled or disposed of Dispose of the MeshDataRecycler (normally on game exit, but can also be used to disable further use of it) Top, Front/Left, Back/Right, Bottom Top, Front/Left, Back/Right, Bottom Shadings by Blockfacing index XYZ Vertex positions for every vertex in a cube. Origin is the cube middle point. Cube face indices, in order: North, East, South, West, Up, Down. UV Coords for every Vertex in a cube Indices for every triangle in a cube Can be used for any face if offseted correctly Returns a default 2x2x2 cube with xyz,uv,rgba and indices set - ready for upload to the graphics card Returns a rgba byte array to be used for default shading on a standard cube, can supply the shading levels Returns a rgba byte array to be used for default shading on a standard cube Same as GetCubeModelData but can define scale and translation. Scale is applied first. Same as GetCubeModelData but can define scale and translation. Scale is applied first. Same as GetCubeModelData but can define scale and translation. Scale is applied first. Scales a mesh retrieced by GetCube() Gets the face of a given cube. The face you want to fetch in cardinal directions. The mesh data for the cube's given face. Gets the face of a given cube. The face you want to fetch in cardinal directions. The horizontal scale. The vertical scale. The translation desired. The mesh data for the given parameters. Holds arbitrary mesh data for meshes to be used in a shader The arbitrary type. The arbitrary data to be uploaded to the graphics card Amout of values currently added Size of the Values array Size of the array that should be allocated on the graphics card. Amount of variable components for variable (i.e. 2, 3 for a vec2 and a vec3), valid values are 1, 2, 3 and 4 (limited by glVertexAttribPointer) Stride - Size in bytes of all values for one vertex Offset in bytes for each variable For instanced rendering Set to false if you intend to update the buffer very often (i.e. every frame) Used as offset when doing a partial update on an existing buffer Blank constructor. Array initialization constructor. the size of the typed Array. Grows the buffer with a minimum. The minimum amount to grow the buffer by. Adds a value to the buffer. The value to add. Adds the same value to the buffer 4 times - coded for performance. The value to add. Adds multiple values to the buffer. The values being added. Lets you define your a self defined size to be allocated on the graphics card. If not called the allocation size will be the count of the Elements in the Array Use the element count as the allocation size (default behavior) Sets a value from a given mesh data part. the mesh data part for this type. Sets a value from a given mesh data part. the mesh data part for this type. Holds arbitrary byte data for meshes to be used in the shader Empty Constructor. Size initialization constructor. adds values to the bytes part per four bytes. the integer mask of four separate bytes. Creates a clone of this collection of data parts. A clone of this collection of data parts. Holds arbitrary float data for meshes to be used in the shader Empty Constructor. Size initialization constructor. Creates a clone of this collection of data parts. A clone of this collection of data parts. Holds arbitrary int data for meshes to be used in the shader Empty constructor. Size initialization constructor. Creates a clone of this collection of data parts. A clone of this collection of data parts. Holds arbitrary short data for meshes to be used in the shader. radfast note: actually interpreted by the shader as ushort Empty constructor. Size initialization constructor. Creates a clone of this collection of data parts. A clone of this collection of data parts. Gets a mesh pool supplier for the given render pass. The given render pass. The mesh data for the render pass. Gets the current rectangle for the line. the converted base color. The mesh data for the rectangle.. Gets the cube of this line. The converted base color. The mesh data for the cube. Adds a 2D line to the mesh data. The current mesh data. X position of the first point. Y position of the first point. X position of the second point. Y position of the second point. The converted base color. Adds a collection of lines to the given mesh. The current mesh data. The first point. The second point. The third point. The fourth point. The color of the resulting lines. Adds a vertex to the mesh data. The mesh data. X position of the vertex. Y position of the vertex. Z position of the vertex. The color of the vertex. A data structure that can be used to upload mesh information onto the graphics card Please note, all arrays are used as a buffer. They do not tightly fit the data but are always sized as a multiple of 2 from the initial size. The x/y/z coordinates buffer. This should hold VerticesCount*3 values. The render flags buffer. This should hold VerticesCount*1 values. True if the flags array contains any wind mode The normals buffer. This should hold VerticesCount*1 values. Currently unused by the engine. GL_INT_2_10_10_10_REV Format x: bits 0-9 (10 bit signed int) y: bits 10-19 (10 bit signed int) z: bits 20-29 (10 bit signed int) w: bits 30-31 The uv buffer for texture coordinates. This should hold VerticesCount*2 values. The vertex color buffer. This should hold VerticesCount*4 values. The indices buffer. This should hold IndicesCount values. Texture index per face, references to and index in the TextureIds array Custom floats buffer. Can be used to upload arbitrary amounts of float values onto the graphics card Custom ints buffer. Can be used to upload arbitrary amounts of int values onto the graphics card Custom shorts buffer. Can be used to upload arbitrary amounts of short values onto the graphics card Custom bytes buffer. Can be used to upload arbitrary amounts of byte values onto the graphics card When using instanced rendering, set this flag to have the xyz values instanced. When using instanced rendering, set this flag to have the uv values instanced. When using instanced rendering, set this flag to have the rgba values instanced. When using instanced rendering, set this flag to have the rgba2 values instanced. When using instanced rendering, set this flag to have the indices instanced. When using instanced rendering, set this flag to have the flags instanced. xyz vbo usage hints for the graphics card. Recommended to be set to false when this section of data changes often. uv vbo usage hints for the graphics card. Recommended to be set to false when this section of data changes often. rgab vbo usage hints for the graphics card. Recommended to be set to false when this section of data changes often. rgba2 vbo usage hints for the graphics card. Recommended to be set to false when this section of data changes often. indices vbo usage hints for the graphics card. Recommended to be set to false when this section of data changes often. flags vbo usage hints for the graphics card. Recommended to be set to false when this section of data changes often. For offseting the data in the VBO. This field is used when updating a mesh. For offseting the data in the VBO. This field is used when updating a mesh. For offseting the data in the VBO. This field is used when updating a mesh. For offseting the data in the VBO. This field is used when updating a mesh. For offseting the data in the VBO. This field is used when updating a mesh. For offseting the data in the VBO. This field is used when updating a mesh. For offseting the data in the VBO. This field is used when updating a mesh. The meshes draw mode Amount of currently assigned normals Amount of currently assigned vertices Amount of currently assigned indices Vertex buffer size Index buffer size BlockShapeTesselator xyz faces. Required by TerrainChunkTesselator to determine vertex lightness. Should hold VerticesCount / 4 values. Set to 0 for no face, set to 1..8 for faces 0..7 Amount of assigned xyz face values BlockShapeTesselator climate colormap ids. Required by TerrainChunkTesselator to determine whether to color a vertex by a color map or not. Should hold VerticesCount / 4 values. Set to 0 for no color mapping, set 1..n for color map 0..n-1 BlockShapeTesselator season colormap ids. Required by TerrainChunkTesselator to determine whether to color a vertex by a color map or not. Should hold VerticesCount / 4 values. Set to 0 for no color mapping, set 1..n for color map 0..n-1 BlockShapeTesselator renderpass. Required by TerrainChunkTesselator to determine in which mesh data pool each quad should land in. Should hold VerticesCount / 4 values.
Lower 10 bits = render pass
Upper 6 bits = extra bits for tesselators
Bit 10: DisableRandomDrawOffset Amount of assigned tint values Amount of assigned render pass values If true, this MeshData was constructed from MeshDataRecycler The time this MeshData most recently entered the recycling system; the oldest may be garbage collected Gets the number of verticies in the the mesh. The number of verticies in this mesh. ..Shouldn't this be a property? Sets the number of verticies in this mesh. The number of verticies in this mesh ..Shouldn't this be a property? Gets the number of Indicices in this mesh. The number of indicies in the mesh. ..Shouldn't this be a property? Sets the number of indices in this mesh. The number of indices in this mesh. The size of the position values. The size of the normals. The size of the color. The size of the Uv. the size of the index. the size of the flags. returns VerticesCount * 3 returns VerticesCount * 4 returns VerticesCount * 4 returns VerticesCount returns VerticesCount * 2 Offset the mesh by given values Offset the mesh by given values Rotate the mesh by given angles around given origin Scale the mesh by given values around given origin Apply given transformation on the mesh Apply given transformation on the mesh Apply given transformation on the mesh - specifying two temporary vectors to work in (these can then be re-used for performance reasons) a re-usable float[4], values unimportant origin point Apply given transformation on the mesh Creates a new mesh data instance with no components initialized. Creates a new mesh data instance with given components, but you can also freely nullify or set individual components after initialization Any component that is null is ignored by UploadModel/UpdateModel This constructor creates a basic MeshData with xyz, Uv, Rgba, Flags and Indices only; Indices to Vertices ratio is the default 6:4 Sets up the tints array for holding tint info Sets up the xyzfaces array for holding xyzfaces info Sets up the renderPasses array for holding render pass info Sets up the renderPasses array for holding render pass info Add supplied mesh data to this mesh. If a given dataset is not set, it is not copied from the sourceMesh. Automatically adjusts the indices for you. Is filtered to only add mesh data for given render pass. A negative render pass value defaults to EnumChunkRenderPass.Opaque Add supplied mesh data to this mesh. If a given dataset is not set, it is not copied from the sourceMesh. Automatically adjusts the indices for you. Removes the last index in the indices array Removes the last vertex in the vertices array Removes the last "count" vertices from the vertex array Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Adds a new vertex to the mesh. Grows the vertex buffer if necessary. Applies a vertex flag to an existing MeshData (uses binary OR) Adds a new normal to the mesh. Grows the normal buffer if necessary. Adds a new normal to the mesh. Grows the normal buffer if necessary. Add 6 indices Doubles the size of the xyz, uv, rgba, rgba2 and flags arrays Resizes all buffers to tightly fit the data. Recommended to run this method for long-term in-memory storage of meshdata for meshes that won't get any new vertices added Creates a compact, deep copy of the mesh Clone the basic xyz, uv, rgba and flags arrays, which are common to every chunk mesh (though not necessarily all used by individual block/item/entity models) Clone the extra mesh data fields. Some of these fields are used only by block/item meshes (some only be Microblocks). Some others are not used by all chunk meshes, though may be used by certain meshes in certain renderpasses (e.g. CustomInts). Either way, cannot sensibly be retained within the MeshDataRecycler system, must be cloned every time Allows meshdata object to be returned to the recycler Creates an empty copy of the mesh Sets the counts of all data to 0 Returns a copy of this mesh with the uvs set to the specified TextureAtlasPosition Sets the uvs of this mesh to the specified TextureAtlasPosition, assuming the initial UVs range from 0..1, as they will be scaled by the texPos Sets given flag if vertex y > WaveFlagMinY, otherwise it clears all wind mode bits Default is EnumWindBitModeMask.NormalWind Utility class for simple quad meshes Returns a single vertical quad mesh of with vertices going from -1/-1 to 1/1 With UV, without RGBA Quad without rgba, with uv Returns a single vertical quad mesh at given position, size and color Returns a single horziontal quad mesh with given params Returns a custom quad mesh with the given params. Currently falling Is now outside the world (x/y/z below -30 or x/z above mapsize + 30) Was falling and has now collided with the terrain Updates the velocity vector according to the amount of passed time, gravity and terrain collision. The currently configured z-near plane The currently configured z-far plane Each sphere has 8 floats: 3 floats x/y/z offset to the player 1 float radius 1 float density 3 floats rgb color 0..1 (0 for left, 0.5 for left&right, 1 for right) The various render passes available for rendering blocks Backfaced culled, no alpha testing, alpha discard Backfaced not culled, no alpha blended but alpha discard Backfaced not culled, alpha blended and alpha discard Uses a special rendering system called Weighted Blended Order Independent Transparency for half transparent blocks Used for animated liquids Special render pass for top soil only in order to have climated tinted grass half transparently overlaid over an opaque block Special render pass for meta blocks Uses the depth buffer from the OIT pass to prevent water plants showing in sailboats Draw types for blocks. You will most likely use JSON for all assets with custom shapes. Types that determine how block faces should be culled. Culls faces if they are opaque faces adjacent to opaque faces Never culls any faces Culls all faces that are adjacent to opaque faces and faces adjacent to blocks of the same id Calls method Block.ShouldMergeFace() to determine whether to cull the face or not Culls all faces that are adjacent to opaque faces and the bottom, east or south faces adjacent to blocks of the same id This causes to still leave one single face inbetween instead of 2, eliminating any z-fighting. Same as Merge but checks for equal material Same as Collapse but checks for equal material Same as CollapseMaterial but also culls faces towards opaque blocks Used for blocks similar to Farmland or StonePath, which are not themselves opaque except on the base, but can cull horizontal sides if adjacent block is opaque (or the same id) Culls non-opaque faces if the same block is adjacent e.g. a wide staircase made from several Stairs blocks side-by-side (caution: in future this cull mode will not work with corner stairs shapes) The render taget for an item stack Rendered in a UI, usually the inventory Rendered in the players hand, first person mode Rendered in the players hand, third person mode Rendered in the players off hand, third person mode Rendered when dropped on the ground Before any rendering has begun, use for setting up stuff during render Opaque/Alpha tested rendering Order independent transparency To render the held item over water. If done in the opaque pass it would not render water behind it. Shadow map Shadow map done Shadow map Shadow map done After all 3d geometry has rendered and post processing of the frame is complete Scene has been rendered onto the default frame buffer, but not yet rendered UIs Ortho mode for rendering GUIs and everything 2D The post processing passes are merged with all 3d geometry and the scene is color graded Scene is blitted onto the default frame buffer, buffers not yet swapped though so can still render to default FB A very plain shader for drawing any geometry For instanced rendering of cubic particles For instanced rendering of quad particles For rendering the sky colors For rendering the stars skybox Debug shader for testing Weighted Blended Order Independent Merges opaque geomerty with WOIT geometry For rendering the currently held item Renders opaque chunk geometry, no blend, alpha discard; Debug shader Renders liquid chunk geometry Renders decals, obviously O_O Color grading and merging of all rendered scenes For drawing an item stack The Blur shader Renders half transparent chunk geometry using WOIT For bloom shader Renders top soil chunk geometry For god rays Cinematic camera pather rendering Worldedit block highlights The selected block outline For animated entities Luma prepass for FXAA Creates a Plane with normalised (length 1.0) normal vector If distance squared is above this fraction of ViewDistanceSq, switch to LOD2. Default value corresponds to distances beyond around 67% of the player's view distance. At default, approximately 55% of the total rendered chunks will use LOD2. Index order: Near 0, Left 1, Right 2, Top 3, Bottom 4, Far 5 Calculating the frustum planes. From the current OpenGL modelview and projection matrices, calculate the frustum plane equations (Ax+By+Cz+D=0, normal=(A,B,C)) The equations can then be used to see on which side points are. If set, the shader registry will attach this bit of code to the beginning of the fragment shader file. Useful for setting stuff at runtime when using file shaders, e.g. via #define Source code of the shader When loading from file this is the asset domain to load from A uniqe shader pass number assigned to each shader program The name it was registered with. If you want to load this shader from a file, make sure the use the filename here If true, it well configure the textures to clamp to the edge (CLAMP_TO_EDGE). Requires the textureid to be defined using SetTextureIds The vertex shader of this shader program The fragment shader of this shader program The geometry shader of this shader program True if this shader has been disposed The texture 2D for this mesh. The shadowmap ID for nearby shadows. The shadowmap ID for far away shadows. The Near plane distance. The far plane distance. The shader will discard things below this threshold. The color of the ambient light source. The color of the general light. The color of the glow light. The color of the fog. The color of the tint. When TempGlowMode==1 this color is used as a reference The minimum distance for fog. The density level of the fog. The projection matrix. The model Matrix. The view matrix. The matrix for converting the vertex position from world space to far shadow space as supplied by IRenderAPI.CurrentShadowProjectionMatrix. The matrix for converting the vertex position from world space to near shadow space as supplied by IRenderAPI.CurrentShadowProjectionMatrix. Required for water waving meshes. Supplied the water counter as supplied as IRenderAPI.WaterWaveCounter. The position of the player. Requires xyz, uv, rgba, indices, flags and xyzFaces to be set Add mesh data, but first transformed with tfMatrix Requires xyz, uv, rgba, indices, flags and xyzFaces to be set Defines a texture to be overlayed on another texture. The path to the texture to use as an overlay. The type of blend for each pixel. Holds data about a texture. Also allows textures to be overlayed on top of one another. "textures": { "charcoal": { "base": "block/coal/charcoal" }, "coke": { "base": "block/coal/coke" }, "ore-anthracite": { "base": "block/coal/anthracite" }, "ore-lignite": { "base": "block/coal/lignite" }, "ore-bituminouscoal": { "base": "block/coal/bituminous" }, "ember": { "base": "block/coal/ember" } }, "textures": { "ore": { "base": "block/stone/rock/{rock}1", "overlays": [ "block/stone/ore/{ore}1" ] } }, Connected textures example (See https://discord.com/channels/302152934249070593/479736466453561345/1134187385501007962) "textures": { "all": { "base": "block/stone/cobblestone/tiling/1", "tiles": [ { "base": "block/stone/cobblestone/tiling/*" } ], "tilesWidth": 4 } } The basic texture for this composite texture Obsolete. Use instead. A set of textures to overlay above this texture. The base texture may be overlayed with any quantity of textures. These are baked together during texture atlas creation. The texture may consists of any amount of alternatives, one of which will be randomly chosen when the block is placed in the world. A way of basic support for connected textures. Textures should be named numerically from 1 to squared.
E.g., if is 3, the order follows the pattern of:
1 2 3
4 5 6
7 8 9 The number of tiles in one direction that make up the full connected textures defined in . BakedCompositeTexture is an expanded, atlas friendly version of CompositeTexture. Required during texture atlas generation. Rotation of the texture may only be a multiple of 90 Can be used to modify the opacity of the texture. 255 is fully opaque, 0 is fully transparent. Creates a new empty composite texture Creates a new empty composite texture with given base texture Creates a deep copy of the texture Tests whether this is a basic CompositeTexture with an asset location only, no rotation, alpha, alternates or overlays Expands the Composite Texture to a texture atlas friendly version and populates the Baked field. This method is called by the texture atlas managers. Won't have any effect if called after the texture atlasses have been created. Expands the Composite Texture to a texture atlas friendly version and populates the Baked field. This method can be called after the game world has loaded. The Client API The atlas to insert the baked texture. Expands a CompositeTexture to a texture atlas friendly version and populates the Baked field An expanded, atlas-friendly version of a CompositeTexture Unique identifier for this texture The Base name and Overlay concatenated (if there was any defined) The base name and overlays as array If non-null also contains BakedName If non-null also contains BakedName For tiled textures, returns the selector index for which one of the tiles to use, for the given x,y,z position and tileSide An interface that can supply texture atlas positions This returns the size of the atlas this texture resides in. Helper class for implementors of ITexPositionSource A reference to a texture that has been uploaded onto the graphics cards, if TextureId is not zero The OpenGL Texture Id Width of the texture. Height of the texture. Set this only you really know what you're doing Creates an empty loaded texture context with the Client API. The Client API Creates a loaded texture context with pre-set texture information. The Client API The ID of the texture. The width of the texture. The height of the texture. Disposes of the loaded texture safely. The position of a texture inside an atlas The OpenGL textureid A sequential number in which atlas this position is in. Atlasses for a given type are sequentially numbered if more than one atlas was required to hold all the textures A sequential number that goes up with every texture atlas reload, used to see if this texpos is still fresh The x coordinate of the texture origin point The y coordinate of the texture origin point The x coordinate of the texture end point The y coordinate of the texture end point Called by the texture atlas manager when building up the block atlas. Has to add all of the blocks textures Represent a font with sizing and styling for use in rendering text The static Context for all Cairo Fonts. Whether or not the font is rendered twice. Creates an empty CairoFont instance. Creates a pre-populated CairoFont instance. The configuration for the CairoFont Creates a CairoFont object. The size of the font before scaling is applied. The name of the font. Creates a CairoFont object The size of the font before scaling is applied. The name of the font. The color of the font. The color for the stroke of the font. (Default: Null) Adjust font size so that it fits given bounds The text of the object. The bounds of the element where the font is displayed. Adjust the bounds so that it fits given text in one line The text to adjust The bounds to adjust the text to. If true, the box will not be made smaller Sets the color of the CairoFont. The color to set. Adds a weight to the font. The weight of the font. Sets the font to render twice. Sets up the context. Must be executed in the main thread, as it is not thread safe. The context to set up the CairoFont with. Gets the font's extents. The FontExtents for this particular font. Gets the extents of the text. The text to extend. The Text extends for this font with this text. Clone function. Creates a duplicate of this Cairofont. The duplicate font. Sets the base size of the CairoFont. The new font size Creates a Button Text preset. The button text preset. Creates a text preset for when the button is pressed. The text preset for a pressed button. Creates a text preset for text input fields. The text field input preset. Creates a text oreset for smaller text input fields. The smaller text input preset. Creates a white text for medium dialog. The white text for medium dialog. Creates a white text for smallish dialogs. The white text for small dialogs. Creates a white text for smallish dialogs, using the specified base font Creates a white text for small dialogs. The white text for small dialogs Creates a white text for details. A white text for details. Dialogue Composer for the GUIDialogue. Returns all composers as a flat list Constructor. The dialogue this composer belongs to. Cleans up and clears the composers. Clean disposal method. Returns the composer for given composer name Checks to see if the key is located within the given dialogue composer. The key you are searching for. Do we have your key? Removes the given key and the corresponding value from the Dialogue Composer. The Key to remove. The Instance of Dialogue Composer for this GUIDialogue. A single composer for this GUIDialogue. Debug name. For debugging purposes. The amount of depth required for this dialog. Default is 150. Required for correct z-ordering of dialogs. Is the dialogue currently in focus? Can this dialog be focused? Is this dialogue a dialogue or a HUD object? The event fired when this dialogue is opened. The event fired when this dialogue is closed. Constructor for the GUIDialogue. The Client API. Makes this gui pop up once a pre-set given key combination is set. 0 = draw first, 1 = draw last. Used to enforce tooltips and held itemstack always drawn last to be visible.
Vanilla dialogs draw order:
Name tags: -0.1
Chat dialog: 0
Block Interaction help: 0.05
Worldmap HUD: 0.07
Default value for most other dialogs: 0.1
Worldmap Dialog: 0.11
Player and Chest inventories: 0.2
Various config/edit dialogs: 0.2
Handbook: 0.2
Escape menu: 0.89 Determines the order on which dialog receives keyboard input first when the dialog is opened. 0 = handle inputs first, 9999 = handle inputs last.
Reference list:
0: Escape menu
0.5 (default): tick profiler, selection box editor, macro editor, survival&creative inventory, first launch info dialog, dead dialog, character dialog, etc.
1: hotbar
1.1: chat dialog Should this dialogue de-register itself once it's closed? (Defaults to no) Fires when the GUI is opened. Fires when the GUI is closed. Attempts to open this dialogue. Was this dialogue successfully opened? Attempts to close this dialogue- triggering the OnCloseDialogue event. Was this dialogue successfully closed? Unfocuses the dialogue. Focuses the dialog If the dialogue is opened, this attempts to close it. If the dialogue is closed, this attempts to open it. Is this dialogue opened? Whether this dialogue is opened or not. Is this dialogue opened in the given context? The composer context. Whether this dialogue was opened or not within the given context. This runs before the render. Local update method. The time that has elapsed. This runs when the dialogue is ready to render all of the components. The time that has elapsed. This runs when the dialogue is finalizing and cleaning up all of the components. The time that has elapsed. Fires when keys are held down. The key or keys that were held down. Fires when the keys are pressed. The key or keys that were pressed. Fires when the keys are released. the key or keys that were released. Fires explicitly when the Escape key is pressed and attempts to close the dialogue. Whether the dialogue was closed. Fires when the mouse enters the given slot. The slot the mouse entered. Whether this event was handled. Fires when the mouse leaves the slot. The slot the mouse entered. Whether this event was handled. Fires when the mouse clicks within the slot. The slot that the mouse clicked in. Whether this event was handled. Fires when a mouse button is held down. The mouse button or buttons in question. Fires when a mouse button is released. The mouse button or buttons in question. Fires when the mouse is moved. The mouse movements in question. Fires when the mouse wheel is scrolled. A check for whether the dialogue should recieve Render events. Whether the dialogue is opened or not. A check for whether the dialogue should recieve keyboard events. Whether the dialogue is focused or not. A check if the dialogue should recieve mouse events. Whether the mouse events should fire. Gets whether it is preferred for the mouse to be not grabbed while this dialog is opened. If true (default), the Alt button needs to be held to manually grab the mouse. Gets whether ability to grab the mouse cursor is disabled while this dialog is opened. For example, the escape menu. (Default: false) Should this dialog (e.g. textbox) capture all the keyboard events except for escape. Should this dialog capture the raw mouse button clicks - useful for example for the settings menu itself (in case the user has unset them or set them to something crazy) Disposes the Dialog. Clears the composers. The key combination string that toggles this GUI object. Checks if the player is in range (pickingrange) of the given position In range or no? Base class for dialogs bound to block entities. Gets the opening sound for the dialog being opened, or null if none. Gets the opening sound for the dialog being opened, or null if none. Gets the Y offset of the dialog in-world if floaty GUIs is turned on. 0.5 is the center of the block and larger means it will float higher up. Gets the Y align of the dialog if floaty GUIs is turned on. 0.5 means the dialog is centered on . 0 is top-aligned while 1 is bottom-aligned. The title of this dialogue. Ex: "Chest" The inventory associated with this block entity. The position of this block entity. The Client API The title of this dialogue. Ex: "Chest" The position of this block entity. The Client API This occurs right before the frame is pushed to the screen. The time elapsed. Render's the object in Orthographic mode. The time elapsed. We tunnel our packet through a block entity packet so the block entity can handle all the network stuff Called whenever the scrollbar or mouse wheel is used. The new value of the scrollbar. Occurs whenever the X icon in the top right corner of the GUI (not the window) is pressed. Called whenver the GUI is opened. Attempts to open this gui. Whether the attempt was successful. Called when the GUI is closed. Reloads the values of the GUI. Packet IDs for block entities. A block entity inventory system for things like a campfire, or other things like that. Mainly used for block entity based guis The title of the Dialog. Should this Dialog de-register itself once closed? The tree attributes for this dialog. Constructor for a generic Dialog. The title of the dialog. The Client API Recomposes the dialog with it's set of elements. Unfocuses the elements in each composer. Focuses a specific element in the single composer. Index of the element. Checks if the player is in range of the block. The block's position. In range or no? This is a dialogue built from JSON files. JSON made this gui. Thanks JSON. The debug name of the GUI Key Combination for the GUI Builds the dialog using the dialog settings from JSON. The dialog settings. The Client API Builds the dialog using the dialog settings from JSON. The dialog settings. The Client API Should the first element be focused, after building the dialog? Recomposes the GUI. Composes the dialogue with specifications dictated by JSON. Fires an event when the mouse is held down. The mouse events. Reloads the values in the GUI. First word = X Alignment (left, center, right or fixed) Second word = Y Alignment (top, middle, bottom or fixed) Box sizing model comparable to the box sizing model of cascading style sheets using "position:relative;" Each element has a position, size, padding and margin Padding is counted towards the size of the box, whereas margin is not For debugging purposes only Set the vertical and horizontal sizing, see also . Setting this is equal to calling If set, bgDrawX/Y will be relative, instead of absolute Position relative to it's parent element plus margin Absolute position of the element plus margin. Same as renderX but without padding Width including padding Height including padding Position where the element has to be drawn. This is a position relative to it's parent element plus margin plus padding. Position where the background has to be drawn, this encompasses the elements padding Returns the relative coordinate if supplied coordinate is inside the bounds, otherwise null Returns true if supplied coordinate is inside the bounds Returns true if supplied coordinate is inside the bounds Checks if the bounds is at least partially inside it's parent bounds by checking if any of the 4 corner points is inside Makes a copy of the current bounds but leaves the position and 0. Sets the parent to the calling bounds Makes a copy of the current bounds but leaves the position and padding at 0. Sets the same parent as the current one. Makes a copy of the current bounds but leaves the position and padding at 0. Sets the same parent as the current one. Create a flat copy of the element with a fixed position offset that causes it to be right of the original element Creates a clone of the bounds but without child elements Creates a new elements bounds which acts as the parent bounds of the current bounds. It will also arrange the fixedX/Y and Width/Height coords of both bounds so that the parent bounds surrounds the child bounds with given spacings. Uses fixed coords only! Creates a new elements bounds which acts as the child bounds of the current bounds. It will also arrange the fixedX/Y and Width/Height coords of both bounds so that the parent bounds surrounds the child bounds with given spacings. Uses fixed coords only! Set the fixed y-position to "refBounds.fixedY + refBounds.fixedHeight + spacing" so that the bounds will be under the reference bounds Set the fixed x-position to "refBounds.fixedX + refBounds.fixedWidth + leftSpacing" so that the bounds will be right of reference bounds Set the fixed x-position to "refBounds.fixedX - fixedWith - rightSpacing" so that the element will be left of reference bounds Set the fixed width and fixed height values Set the width property Set the height property Set the alignment property Set the vertical and horizontal sizing property to the same value. See also . Set the vertical and horizontal sizing properties individually. See also . Sets a new fixed margin (pad = top/right/down/left margin) Sets a new fixed margin (pad = top/right/down/left margin) Sets a new fixed padding (pad = top/right/down/left padding) Sets a new fixed padding (x = left/right, y = top/down padding) Sets a new fixed offset that is applied after element alignment. So you could i.e. horizontally center an element and then offset in x direction from there using this method. Sets a new fixed offset that is used during element alignment. Sets a new fixed offset that is used during element alignment. Shrinks the current width/height by a fixed value Grows the current width/height by a fixed value Grows the current width/height by a fixed value Sets the parent of the bounds Creates a new bounds using FitToChildren and sets that as bound parent. This is usefull if you want to draw elements that are not part of the dialog Create a new ElementBounds instance with given fixed x/y position and width/height 0 Quick Method to create a new ElementBounds instance that fills 100% of its parent bounds. Useful for backgrounds. Quick method to create a new ElementBounds instance that uses fixed element sizing. The X/Y Coordinates are left at 0. Quick method to create a new ElementBounds instance that uses fixed element sizing. The X/Y Coordinates are left at 0. Quick method to create new ElementsBounds instance that uses fixed element sizing. Quick method to create new ElementsBounds instance that uses fixed element sizing. Quick method to create new ElementsBounds instance that uses fixed element sizing. Quick method to create new ElementsBounds instance that uses percentual element sizing, e.g. setting percentWidth to 0.5 will set the width of the bounds to 50% of its parent width Quick method to create new ElementsBounds instance that uses percentual element sizing, e.g. setting percentWidth to 0.5 will set the width of the bounds to 50% of its parent width Create a special instance of type whose position is 0 and size 1. It's often used for other bounds that need a static, unchanging parent bounds Just some default sizings for various ui elements Quick method to create a new ElementBounds instance that uses fixed element sizing. The X/Y Coordinates are left at 0. Quick Method to create a new ElementBounds instance that is positioned at the screen center and sized accordingly to fit all it's child elements Quick Method to create a new ElementBounds instance that draws a background for a dialog Quick Method to create a new ElementBounds instance that draws a background for a dialog Quick Method to create a new ElementBounds instance that draws a background for a dialog Quick Method to create a new ElementBounds instance that draws a background for a dialog Quick Method to create a new ElementBounds instance to create a menu consiting of one ore more vertically arranged and horizontally centered buttons in a grid. The y position is calculated using rowIndex * 80. Quick Method to create a new ElementBounds instance to create a menu consiting of one ore more vertically arranged and horizontally centered buttons in a grid. The y position is calculated using rowIndex * 80. Quick Method to create a new ElementBounds instance that is currently used for Signs (e.g. graphics options) Creates a scrollbar right of given element bounds, requires the left element to be using fixed element positioning Only multiplied with scale factor Value between 0 and 100% of parent element Size determined by child elements Value between 0 and 100% of parent element. Will substract fixedWidth and fixedHeight from the final size A class containing common values for elements before scaling is applied. The padding between the element and the dialogue. 20f. The padding between other things. 5f. The padding between the dialogue and the screen. 10f. The height of the title bar. 30. The radius of the dialogue background. 1. The radius of the element background. 1. The size of the large font. 40. The size of the normal fonts. Used for text boxes. 30. The fonts that are slightly smaller than normal fonts. 24. The smaller fonts. 20. The smallest font size used in the game that isn't used with itemstacks. 16. The font size used for specific details like Item Stack size info. 14. The decorative font type. "Lora". The standard font "Montserrat". Set by the client, loaded from the clientsettings.json. Used by ElementBounds to add a margin for left/right aligned dialogs Set by the client, loaded from the clientsettings.json. Used by ElementBounds to add a margin for left/right aligned dialogs The light background color for dialogs. The default background color for dialogs. The strong background color for dialogs. The default dialog border color The Highlight color for dialogs. The alternate background color for dialogs. The default text color for any given dialog. A color for a darker brown. The color of the 1..9 numbers on the hotbar slots The color of the error text. The color of the error text. The color of the the link text. A light brown text color. A hover color for the light brown text. The text color for a disabled object. The color of the actively selected slot overlay The color of the health bar. The color of the oxygen bar The color of the food bar. The color of the XP bar. The color of the title bar. The color of the macro icon. A 100 step gradient from green to red, to be used to show durability, damage or any state other of decay The bounds of the element. The tab index of the element. Whether or not the element has focus. If the element is inside a clip or not. The Client API. Whether or not the element has focus or not. 0 = draw first, 1 = draw last. Only for interactive elements. Whether or not the element can be focused. The scale of the element. The event fired when the element gains focus. The event fired when the element looses focus. Adds a new GUIElement to the GUI. The Client API The bounds of the element. Composes the elements. The context of the components. The surface of the GUI. Renders the element as an interactive element. The change in time. The post render of the interactive element. The change in time. Renders the focus overlay. The change in time. Generates a texture with an ID. The image surface supplied. The previous texture id. Whether or not the texture will have linear magnification. Generates a texture with an ID. (A static version of generateTexture()) The image surface supplied. The previous texture id. Whether or not the texture will have linear magnification. Generates a new texture. The surface provided. The texture to be loaded into. Whether or not the texture will have linear magnification. Changes the scale of given value by the GUIScale factor. The scaled value based Changes the scale of given value by the GUIScale factor Scaled value type cast to int Generates context based off the image surface. The surface where the context is based. The context based off the provided surface. Generates context based off the image surface. (A static version of genContext(), identical behavior) The surface where the context is based. The context based off the provided surface. Gets a surface pattern based off the bitmap. The provided bitmap. The resulting surface pattern. Gets a surface pattern based off the bitmap. The provided bitmap. The resulting surface pattern. Gets an image surface based off the bitmap. The provided bitmap. The image surface built from the bitmap. Gets an image surface based off the bitmap. The provided bitmap. The image surface built from the bitmap. Gets an image surface based off the bitmap. The provided bitmap. The width requested. The height requested. The image surface built from the bitmap and data. Gets an image surface based off the bitmap. The provided bitmap. The width requested. The height requested. The image surface built from the bitmap and data. Gets a surface pattern from a named file. The Client API The name of the file. Do we cache the file? The resulting surface pattern. Fetches an image surface from a named file. The Client API The name of the text file. Fills an area with a pattern. The Client API The context of the fill. The name of the texture file. Whether or not to preserve the aspect ratio of the texture. The surface pattern filled with the given texture. Discards a pattern based off the the filename. The pattern to discard. Makes a rectangle with the provided context and bounds. The context for the rectangle. The bounds of the rectangle. Makes a rectangle with specified parameters. Context of the rectangle The X position of the rectangle The Y position of the rectangle The width of the rectangle The height of the rectangle. Creates a rounded rectangle. The GUI context The bounds of the rectangle. Creates a rounded rectangle element. The context for the rectangle. The bounds of the rectangle. Is the rectangle part of a background GUI object (Default: false) The radius of the corner of the rectangle (default: -1) Creates a rounded rectangle The context for the rectangle. The X position of the rectangle The Y position of the rectangle The width of the rectangle The height of the rectangle. The radius of the corner of the rectangle. Shades a path with the given context. The context of the shading. The thickness of the line to shade. Adds an embossed rounded rectangle to the dialog. The context of the rectangle. The X position of the rectangle The Y position of the rectangle The width of the rectangle The height of the rectangle. Whether or not it goes in or out. Adds an embossed rounded rectangle to the dialog. The context of the rectangle. The X position of the rectangle The Y position of the rectangle The width of the rectangle The height of the rectangle. Whether or not it goes in or out. The depth of the emboss. The radius of the corner of the rectangle. Adds an embossed rounded rectangle to the dialog. The context of the rectangle. The position and size of the rectangle. Whether or not it goes in or out. (Default: false) The depth of the emboss. (Default: 2) The radius of the corner of the rectangle. (default: -1) Adds an embossed rounded rectangle to the dialog. The context of the rectangle. The X position of the rectangle The Y position of the rectangle The width of the rectangle The height of the rectangle. The radius of the corner of the rectangle. The thickness of the emboss. (Default: 3) The intensity of the emboss. (Default: 0.4f) How skewed is the light/dark balance (Default: 1) Whether or not it goes in or out. (Default: false) The offset for the alpha part of the emboss. (Default: 0) The event fired when the mouse is down the element is around. Fires before OnMouseDownOnElement, however OnMouseDownOnElement is called within the base function. The Client API The mouse event args. The event fired when the mouse is pressed while on the element. Called after OnMouseDown and tells the engine that the event is handled. The Client API The mouse event args. The event fired when the mouse is released on the element. Called after OnMouseUp. The Client API The mouse event args. The event fired when the mouse is released. The Client API. The arguments for the mouse event. The event fired when the mouse is moved. The Client API. The mouse event arguments. The event fired when the mouse wheel is scrolled. The Client API The mouse wheel arguments. The event fired when a key is held down. The client API The key event arguments. The event fired when a key is held down. The client API The key event arguments. The event fired the moment a key is pressed. The Client API. The keyboard state when the key was pressed. Whether or not the point on screen is inside the Element's area. The X Position of the point. The Y Position of the point. The compressed version of the debug outline color as a single int value. Creates a toggle button for the GUI. Returns a previously added color list picker element Selects one of the colors from a color list picker Adds a range of clickable colors Adds a compact vertical scrollbar to the current GUI. The event fired for the change in the scrollbar. the bounds of the scrollbar. the internal name of the scrollbar. Gets the scrollbar from the dialogue. the internal name of the scrollbar to be gotten The scrollbar with the given key. Adds a multiple select dropdown to the current GUI instance. The values of the current drodown. The names of those values. The default selected index. The event fired when the index is changed. The bounds of the index. The name of this dropdown. Adds a dropdown to the current GUI instance. The values of the current drodown. The names of those values. The default selected index. The event fired when the index is changed. The bounds of the index. The name of this dropdown. Adds a dropdown to the current GUI instance. The values of the current drodown. The names of those values. The default selected index. The event fired when the index is changed. The bounds of the index. The name of this dropdown. Gets the Drop Down element from the GUIComposer by their key. the name of the dropdown to fetch. Adds multiple buttons with Text. The event fired when the button is pressed. The bounds of the buttons. The key given to the bundle of buttons. Adds a set of horizontal tabs to the GUI. The collection of tabs. The bounds of the horizontal tabs. The event fired when the tab is clicked. The font of the tabs. The key for the added horizontal tabs. Gets the HorizontalTabs element from the GUI by name. The key for the horizontal tabs you want to get. Returns the icon list picker Selects one of the clickable icons Adds multiple clickable icons Adds a vertical scrollbar to the GUI. The action when the scrollbar changes. The bounds of the scrollbar. The name of the scrollbar. Gets the scrollbar by name. The name of the scrollbar. The scrollbar itself. Adds a slider to the current GUI. The event that fires when the slider's value is changed. The bounds of the slider. the internal name of the slider. Gets the slider by name from the GUI. the internal name of the slider. the slider. Adds a switch to the GUI. The event that happens when the switch is toggled. The bounds of the switch. the name of the switch. (Default: null) The size of the switch (Default: 30) The padding around the switch (Default: 5) Gets the switch by name. The internal name of the switch. Returns the named switch. Adds a clickable button The text displayed inside the button Handler for when the button is clicked The font to be used for the text inside the button. Adds a clickable button button with font CairoFont.ButtonText() The text displayed inside the button Handler for when the button is clicked Adds a small clickable button with font size GuiStyle.SmallFontSize The text displayed inside the button Handler for when the button is clicked Gets the button by name Gets the toggle button by name in the GUIComposer. The name of the button. A button. Creates a toggle button with the given parameters. The text of the button. The font of the text. The event that happens once the button is toggled. The bounding box of the button. The name of the button for easy access. Adds an icon button. The name of the icon. The event that happens once the button is toggled. The bounding box of the button. The name of the button for easy access. Toggles the given button. The name of the button that was set. the index of the button. Adds multiple buttons with icons. The collection of icons for the buttons. The font for the buttons. The event called when the buttons are pressed. The bounds of the buttons. The key given to the bundle of buttons. Adds multiple buttons with Text. The texts on all the buttons. The font for the buttons The event fired when the button is pressed. The bounds of the buttons. The key given to the bundle of buttons. Adds multiple tabs to a group of vertical tabs. The tabs being added. The boundaries of the tab group. The event fired when any of the tabs are clicked. The name of this tab group. Adds multiple tabs to a group of vertical tabs. The tabs being added. The boundaries of the tab group. The event fired when any of the tabs are clicked. The name of this tab group. Gets the vertical tab group as declared by name. The name of the vertical tab group to get. Adds a List to the current GUI. The bounds of the cell. the event fired when the cell is requested by the GUI The cells of the list. The identifier for the list. Gets the list by name. The name of the list to get. Adds a chat input to the GUI. The bounds of the text. The event fired when the text is changed. The name of this chat component. Gets the chat input by name. The name of the chat input component. The named component. Adds a config List to the current GUI. The items to add. The event fired when the item is clicked. The font of the Config List. The bounds of the config list. The name of the config list. Gets the config list by name. The name of the config list. Adds a container to the current GUI. Can be used to add any gui element within a scrollable window. The bounds of the cell. The identifier for the list. Gets the container by key The name of the list to get. Adds a dialog title bar to the GUI. The text of the title bar. The event fired when the title bar is closed. The font of the title bar. The bounds of the title bar. Adds a dialog title bar to the GUI with a background. The text of the title bar. The event fired when the title bar is closed. The font of the title bar. The bounds of the title bar. Adds a numeric input for the current GUI. The bounds of the number input. The event fired when the number is changed. The font for the numbers. The name for this GuiElementNumberInput Gets the number input by name. The internal name of the numeric input. The named numeric input. Adds a stat bar to the current GUI with a minimum of 0 and a maximum of 100. The bounds of the stat bar. The color of the stat bar. If true, the element can be fully hidden without recompose. The internal name of the stat bar. Adds a stat bar with filling in the opposite direction. Default values are from 0 to 100. the bounds of the stat bar. the color of the stat bar. The internal name of the stat bar. Gets the stat bar by name. The internal name of the stat bar to fetch. The named stat bar. Adds a text area to the GUI. The bounds of the Text Area The event fired when the text is changed. The font of the text. The name of the text area. Gets the text area by name. The name of the text area. The named Text Area. Adds a text input to the current GUI. The bounds of the text input. The event fired when the text is changed. The font of the text. The name of this text component. Gets the text input by input name. The name of the text input to get. The named text input Adds an item slot grid to the GUI. The inventory attached to the slot grid. A handler that should send supplied network packet to the server, if the inventory modifications should be synced The number of columns in the slot grid. the bounds of the slot grid. The key for this particular slot grid. Adds an item slot grid to the GUI. The inventory attached to the slot grid. A handler that should send supplied network packet to the server, if the inventory modifications should be synced The number of columns in the slot grid. The slots within the inventory that are currently accessible. the bounds of the slot grid. The key for this particular slot grid. Gets the slot grid by name. The name of the slot grid to get. Adds an ItemSlotGrid with Exclusions. The attached inventory. A handler that should send supplied network packet to the server, if the inventory modifications should be synced The number of columns. The slots that have been excluded from the slot grid. The bounds of the slot grid. The name of the slot grid. Gets the ItemSlotGridExcl by name. The name of the ItemSlotGridExcl Adds a passive item slot to the GUI. The bounds of the Slot The inventory attached to the slot. The internal slot of the slot. Do we draw the background for this slot? (Default: true) Adds a skill item grid to the GUI. The items that represent skills. the columns in the skill item grid. The rows in the skill item grid. The effect when a slot is clicked. The bounds of the item grid. The name of the item grid to add. Fetches the skill item grid by name The name of the skill item grid to get. The skill item grid to get. Adds an embossed text component to the GUI. The text of the component. The font of the text. The bounds of the component. The name of the component. Gets the EmbossedText component by name. The name of the component. the named component of the text. Adds a hover text to the GUI. The text of the text. The font of the text. The width of the text. The bounds of the text. The name of this hover text component. Adds a hover text to the GUI. The text of the text. The font of the text. The width of the text. The bounds of the text. The name of this hover text component. Adds a hover text to the GUI. The text of the text. The font of the text. The width of the text. The bounds of the text. The name of this hover text component. Fetches the hover text component by name. The name of the text component. Adds a rich text element to the GUI Adds a rich text element to the GUI Adds a rich text element to the GUI Gets the chat input by name. The name of the chat input component. The named component. Adds a static custom draw component to the GUI. The bounds of the component. The event fired when the element is drawn. Adds a static custom draw component to the GUI. The bounds of the component. The event fired when the element is drawn. Adds a dynamic custom draw component to the GUI. The bounds of the component. The event fired when the element is drawn. The name of the element. Adds shaded, slighlty dirt textured background to the GUI. Adds a static text component to the GUI The text of the text component. The font of the text. The bounds of the text container. The name of the component. Adds a static text component to the GUI The text of the text component. The font of the text. The orientation of the text. The bounds of the text container. The name of the component. Adds a static text component to the GUI that automatically resizes as necessary. The text of the text component. The font of the text. The orientation of the text. The bounds of the text container. The name of the component. Adds a static text component to the GUI that automatically resizes as necessary. The text of the text component. The font of the text. The bounds of the text container. The name of the component. Gets the static text component by name. The name of the component. The padding around the scrollbar. Can this GUIElement be focusable? (default: true). Scrollbar constructor. Client API Event for the changing of the scrollbar or scrolling of the mousewheel. the bounding box of the scrollbar. Composes the element. The context of the element The surface of the image for the element (Not used, can be null.) Renders the element. The amount of time that has passed. An element that allows input and can be disabled Constructor for the element. The Client API. the bounds of the element. Enables/disables the given element (default is enabled) Creates a drop-down list of items. The draw order of this GUI Element. Can this element be put into focus? The scale of this GUI element. Constructor. The client API The values of the strings. The names of the strings. The default selected index. The event that occurs when the selection is changed. The bounds of the drop down. Composes the element based on the context. The context of the element. The surface of the image. (Not used) Renders the dropdown's interactive elements. The change in time. Sets the current index to a newly selected index. the index that is to be selected. Sets the current index to the value of the selected string. the string contained in the drop down. Sets the values of the list with their corresponding names. The values of the list. The names of the list. Creates a toggle button for the GUI. Is this button on? Is this element capable of being in the focus? Constructor for the button The core client API. The bounding box of the button. Composes the element in both the pressed, and released states. The context of the element. The surface of the element. Neither the context, nor the surface is used in this function. Renders the button. The time elapsed. Handles the mouse button press while the mouse is on this button. The client API The mouse event arguments. Handles the mouse button release while the mouse is on this button. The client API The mouse event arguments Handles the event fired when the mouse is released. The client API Mouse event arguments Sets the value of the button. Am I on or off? Disposes of the button. Creates a collection of horizontal tabs. The client API A collection of GUI tabs. The font for the name of each tab. The bounds of each tab. The event fired whenever the tab is clicked. Sets the current tab to the given index. The current index of the tab. Creates a toggle button for the GUI. Max height of the expanded list The (first) currently selected element The element the user currently has the mouse over On multi select mode, the list of all selected elements Is the current menu opened? Creates a new GUI Element List Menu The Client API. The values of the list. The names for each of the values. The default selected index. The event fired when the selection is changed. The bounds of the GUI element. Composes the list of elements dynamically. Opens the menu. Sets the selected index. The index to be set to. Sets the selected index to the given value. The value to be set to. Sets the list for the GUI Element list value. The values of the list. The names of the values. Moving 1 pixel of the scrollbar moves the content by ScrollConversionFactor of pixels The current Y position of the inner element Creates a new Scrollbar. The client API. The event that fires when the scrollbar is changed. The bounds of the scrollbar. Sets the height of the scrollbar. The visible height of the scrollbar The total height of the scrollbar. Sets the total height, recalculating things for the new height. The total height of the scrollbar. Triggers the change to the new value of the scrollbar. Puts the scrollblock to the very bottom of the scrollbar. Builds a slider. A horizontal customizeable slider. The Client API The event that's fired when the slider changed. the bounds of the object. Trigger event only once user release the mouse Sets a value to warn the player that going over this is not a good idea. The maximum limit before things break down. Sets the values of the slider. The value the slider is now. The lowest value. The highest value. Each step between values. The units of the value. %, chunks, ect. Gets the current value of the slider. Trigger event only once user release the mouse Wether the switch has been toggled to On Creates a switch which can be toggled. The Client API The event that happens when the switch is flipped. The bounds of the element. The size of the switch. (Default: 30) The padding on the outside of the switch (Default: 5) Sets the value of the switch on or off. on == true. Creates a button with text. The Client API The text of the button. The font of the text. The font of the text when the player is hovering over the button. The event fired when the button is clicked. The bounds of the button. The style of the button. Sets the orientation of the text both when clicked and when idle. The orientation of the text. Sets the button as active or inactive. Active == clickable Creates a toggle button for the GUI. Is this button toggleable? Is this button on? Is this element capable of being in the focus? Constructor for the button The core client API. The icon name The text for the button. The font of the text. The action that happens when the button is toggled. The bounding box of the button. Can the button be toggled on or off? Composes the element in both the pressed, and released states. The context of the element. The surface of the element. Neither the context, nor the surface is used in this function. Renders the button. The time elapsed. Handles the mouse button press while the mouse is on this button. The client API The mouse event arguments. Handles the mouse button release while the mouse is on this button. The client API The mouse event arguments Handles the event fired when the mouse is released. The client API Mouse event arguments Sets the value of the button. Am I on or off? Disposes of the button. If true, more than one tab can be active Creates a new vertical tab group. The Client API The collection of individual tabs. The font for the group of them all. The bounds of the tabs. The event fired when the tab is clicked. Switches to a different tab. The tab to switch to. Switches to a different tab. The tab to switch to. Whether or not the handler triggers. The bounds of the cell. The event fired when the cell is rendered. The Client API The change in time. Called when the cell is modified and needs to be updated. The cells in the list. See IGuiElementCell for how it's supposed to function. the space between the cells. Default: 10 The padding on the vertical axis of the cell. Default: 2 The padding on the horizontal axis of the cell. Default: 7 Creates a new list in the current GUI. The Client API. The bounds of the list. The event fired when a cell is requested by the gui The array of cells initialized with the list. Calculates the total height for the list. Adds a cell to the list. The cell to add. The position of the cell to add after. (Default: -1) Removes a cell at a specified position. The position of the cell to remove. Adds a chat input element to the UI. The client API The bounds of the chat input. The event fired when the text is altered. A config item for the GUIElementConfigList. Item or title The name of the config item. the value of the config item. The code of the config item. Has this particular config item errored? The y position of the config item. The height of the config item. A configurable list of items. An example of this is the controls in the settings menu. Creates a new dropdown configuration list. The Client API The list of items in the configuration. The event fired when the particular item is clicked. The font of the text. the bounds of the element. Automatically adjusts the height of the element. Refreshes the Config List. The cells in the list. See IGuiElementCell for how it's supposed to function. the space between the cells. Default: 10 The padding on the vertical axis of the cell. Default: 2 The padding on the horizontal axis of the cell. Default: 7 Creates a new list in the current GUI. The Client API. The bounds of the list. Calculates the total height for the list. Gets the currently tabbed index element, if there is one currently focused. Gets the maximum tab index of the components. marks an element as in focus. The tab index to focus at. Whether or not the focus could be done. Unfocuses all elements except one specific element. The element to remain in focus. Adds a cell to the list. The cell to add. The position of the cell to add after. (Default: -1) Removes a cell at a specified position. The position of the cell to remove. A title bar for your GUI. The size of the close icon in the top right corner of the GUI. Creates a new title bar. The Client API. The text on the title bar. The GuiComposer for the title bar. The event fired when the title bar is closed. The font of the title bar. The bounds of the title bar. A numerical input field for inputting numbers. When enabled and a button is clicked it wont focus on it, leaving your focus on the game to move around Creates a numerical input field. The Client API The bounds of the GUI. The event fired when the number is changed. The font of the numbers. Gets the current value of the number. A float representing the value. A stat bar to the GUI for keeping track of progress and numbers. Creates a new stat bar for the GUI. The client API The bounds of the stat bar. The color of the stat bar. Determines the direction that the bar fills. Sets the line interval for the Status Bar. The value to set for the line interval/ Sets the value for the status bar and updates the bar. The new value of the status bar. Sets the value for the status bar as well as the minimum and maximum values. The new value of the status bar. The minimum value of the status bar. The maximum value of the status bar. Sets the minimum and maximum values of the status bar. The minimum value of the status bar. The maximum value of the status bar. Creates a new text area. The client API The bounds of the text area. The event fired when the text is changed. The font of the text. Adds a text input to the GUI The Client API The bounds of the text input. The event fired when the text is changed. The font of the text. Tells the text component to hide the characters in the text. Displays the slots of an inventory in the form of a slot grid Determines the available slots for the slot grid. A base class for the slot grid. For all your slot grid needs. Creates a new instance of this class. The client API The attached inventory A handler that should send supplied network packet to the server, if the inventory modifications should be synced The number of columns in the GUI. The bounds of the slot grid. Renders only a subset of all available slots filtered by searching given text on the item name/description Can be set to increase search performance, otherwise a slow search is performed Highlights a specific slot. The slot to highlight. Removes the active slot highlight. Builds slot grid with exclusions to the grid. Creates a new slot grid with exclusions. The Client API The attached inventory. A handler that should send supplied network packet to the server, if the inventory modifications should be synced The number of columns in the slot grid. The slots that have been excluded. The bounds of the slot grid. Displays a single slot from given inventory, cannot be directly interacted with. Currently used for the mouse slot Creates a new passive item slot. The client API the bounds of the Slot. the attached inventory for the slot. The slot of the slot. Do we draw the background for this slot? (Default: true) A slot for item skills. Creates a Skill Item Grid. The Client API The items with skills. The columns of the Item Grid The Rows of the Item Grid. The event fired when the slot is clicked. The bounds of the Item Grid. Text that can be changed after being composed Adds a new element that renders text dynamically. The client API. The starting text on the component. The font of the text. the bounds of the text. Automatically adjusts the height of the dynamic text. Recomposes the element for lines. Sets the text value of the element. The text of the component. Whether the height of the component should be modified. Whether the element should be redrawn. Adds dynamic text to the GUI. Gets the Dynamic Text by name from the GUI. The name of the element. Called when a keyboard key was pressed, received and handled Contains the same as Lines, but may momentarily have different values when an edit is being made Initializes the text component. The Client API The font of the text. The bounds of the component. Sets the position of the cursor at a given point. X position of the cursor. Y position of the cursor. Sets the position of the cursor to a specific character. The position in the line. The line of the text. Sets a numerical value to the text, appending it to the end of the text. The value to add to the text. Sets a numerical value to the text, appending it to the end of the text. The value to add to the text. Sets given text, sets the cursor to the end of the text Sets given texts, leaves cursor position unchanged unless it's now invalid Moves the cursor forward and backward by an amount. The direction to move the cursor. Whether or not we skip entire words moving it. Force the cursor to skip whitespace after a word. Sets the number of lines in the Text Area. The maximum number of lines. Limits the number of characters a user may enter (default: no limit). Use -1 to set no limit Creates a new embossed text element. The Client API The text of the component. The font of the text. The bounds of the component. Whether or not the component is enabled. Sets whether or not the component is enabled. Creates a new instance of hover text. The client API. The text of the text. For the text and the text. The font of the text. The width of the text. the bounds of the text. Sets the text of the component and changes it. The text to change. Sets whether the text automatically displays or not. Whether the text is displayed. Sets the visibility to the Sets whether or not the width of the component should automatiocally adjust. Creates an ItemStackInfo element. The client API The bounds of the object. The function that is called when an item information is called. Gets the item slot for this stack info. Sets the source slot for stacks. True if recomposed Creates a NewVersion text component. The Client API The font of the text. The bounds of the component. Recomposes a multi-line message. The version number of the new version. Recomposes the element for lines. Draws an icon Draws an itemstack Draws an itemstack Composes the element. Context of the text component. The surface of the image. Renders the text component. Initializes the size and stuff. Return true if you had to enter the next line True when longer than 1 line Can continue on the same line Element was split between current and next line Element was put on next line The width/height boundaries of this text component per line This will be the Y-Advance into the next line. Unscaled value. Also used as the offset with EnumVerticalAlign.FixedOffset Padding that is used when a richtextcomponent came before and needs some left spacing to it. Unscaled value Unscaled value When left or right, then this element can span over multiple text lines Composes the element. Renders the text component. Initializes the size and stuff. Return true if you had to enter the next line A Draws multiple itemstacks Flips through given array of grid recipes every second If set, will resolve wildcards based on this list, otherwise will search all available blocks/items Draws multiple itemstacks Flips through given array of item stacks every second Looks at the collectibles handbook groupBy attribute and makes a list of itemstacks from that Create a dummy link text component for use with triggering link protocols through code. Not usable for anything gui related (it'll crash if you try) A text component with an embedded link. The text of the Text. Adds a clipped area to the GUI. The Client API Do we clip? The bounds of the element. Add a clip area. Thhis select an area to be rendered, where anything outside will be invisible. Useful for scrollable content. Can be called multiple times, to reduce the render area further, but needs an equal amount of calls to EndClip() The bounds of the object. Remove a previously added clip area. Adds a custom drawing element to the GUI The Client API The bounds of the Element The event fired when the object is drawn. The table cell information. Creates a new Element Cell. A container for TableCells. The Client API The base cell The bounds of the TableCell Updates the height of the cell based off the contents. Renders the main menu cell The title of the Table Cell. The details of the table cell. The text displayed in the top right corner of the cell. The y offset of the right top text The y offset of the left title and detail text The event fired when the tablecell is clicked. The font of the cell title. The font of the detail text. Whether or not the cell is on. Adds a custom drawing element to the GUI The Client API The bounds of the Element The event fired when the object is drawn. Whether or not the element is able to be interacted with (Default: false) Redraws the element. Adds a Background to the Dialog. The Client API The bounds of the element. Minor style adjustments to accomodate title bar The top padding area of the GUI Creates a new Engraved Text element. The client API. The text on the element. The font of the text. The bounds of the Text Element. The orientation of the text. Creates a new overlay element. The client API. The bounds of the element. The background color of the element. Adds an overlay to the current GUI. The bounds of the overlay. The background color of the overlay. Creates a new gray background. The client API The bouds of the GUI Element. Adds a gray background to the current GUI. The bounds of the backgrounds. Creates a new Image Background for the GUI. The Client API The bounds of the element. The name of the texture. The brightness of the texture. (Default: 1f) Adds a background to the current GUI The bounds of the background The name of the background texture. The brightness of the texture (default: 1f) Creates a new inset for the GUI. The Client API The bounds of the Element. The depth of the element. The brightness of the inset. Adds an inset to the current GUI. The bounds of the inset. The depth of the inset. The brightness of the inset. Creates a new GUIElementStaticText. The Client API The text of the Element The orientation of the text. The bounds of the element. The font of the text. Resize element bounds so that the text fits in one line Resize the font so that the text fits in one line Whether or not the text path mode is active. The font of the Text Element. Creates a new text based element. The Client API The text of this element. The font of the text. The bounds of the element. Draws the line of text on a component. The context of the text The text of the text. The X Position of the text. The Y position of the text. The pathing mode. Gets the text on the element. The text of the element. The size of the font before scaling is applied. The name of the font. The weight of the font. The color of the font. The color of the font outline. The thickness of the outline. Composes a dialog which are made from a set of elements The composed dialog is cached, so to recompose you have to Recompose All elements or instantiate a new composer with doCache set to false The caching allows the dialog using the composer to not worry about performance and just call compose whenever it has to display a new composed dialog You add components by chaining the functions of the composer together for building the result. Triggered when the gui scale changed or the game window was resized A unique number assigned to each element Retrieve gui element by key. Returns null if not found. Whether or not the Tab-Key down event should be used and consumed to cycle-focus individual gui elements Creates an empty GuiComposer. The Client API An empty GuiComposer. On by default, is passed on to the gui elements as well. Disabling it means has a performance impact. Recommeded to leave enabled, but may need to be disabled to smoothly alpha blend text elements. Must be called before adding elements and before composing. Notice! Most gui elements even yet support non-premul alpha mode Adds a condition for adding a group of items to the GUI- eg: if you have a crucible in the firepit, add those extra slots. Should always pair with an EndIf() When the following slots should be added End of the AddIf block. Runs given method Starts a set of child elements. The bounds for the child elements. Starts a set of child elements. End of the current set of child elements. Sets the render to Dynamic components only Rebuilds the Composed GUI. Gets the currently tabbed index element, if there is one currently focused. Gets the maximum tab index of the components. marks an element as in focus. The tab index to focus at. Whether or not the focus could be done. Unfocuses the elements within this GUI composer. Unfocuses all elements except one specific element. The element to remain in focus. Tells the composer to compose the gui. Whether or not to put the first element in focus. Fires the OnMouseUp events. The mouse information. Fires the OnMouseDown events. The mouse information. Fires the OnMouseMove events. The mouse information. Fires the OnMouseWheel events. The mouse wheel information. Fires the OnKeyDown events. The keyboard information. Whether or not the gui has focus. Fires the OnKeyDown events. The keyboard information. Fires the OnKeyPress event. The keyboard information Fires the PostRender event. The change in time. Fires the render event. The change in time. Adds an interactive element to the composer. The element to add. The name of the element. (default: null) Adds a static element to the composer. The element to add. The name of the element (default: null) Gets the element by name. The name of the element to get. Base class for Hud Elements. Creates a new Hud Element. The Client API Creates a new IconUtil instance. The Client API. Generates the texture. The width of the drawing The height of the drawing. A delegate which handles the drawing. The resulting built texture. Draws the icon. The context. The type to draw X position of the Icon. Y position of the Icon. Width of the Icon. Height of the Icon. The color of the icon. Draws the icon. The context. The type of icon to draw X position of the Icon. Y position of the Icon. Width of the Icon. Height of the Icon. The color of the icon. Draws 5 vertical bars of increasing size and Quality amount of them green Holds information on how a collectible should be rendered in hands, on the ground or in gui. In collectible.OnBeforeRender() the values are prefilled with the default ones. The model to be rendered The transform to be applied when rendered Wether or not to cull back faces The texture to be used when rendering. Should probalby be the texture id of the block or item texture atlas For discarding fragments with alpha value below this threshold (Currently) not used. The slot the stack is currently in Called whenever the value of a input field has changed Called when the dialog is opened the first time or when dialog.ReloadValues() is called. Should return the values the input fields should be set to Writes the content to the writer. The writer to fill with data. Reads the content to the dialog. The reader to read from. To hold generic data The padding around the text. The radius of the text. The fill color of the background The stroke color of the border The thickness of the border Adds a blur to the background Language specific default setting After every word After any character Do not auto-line break, only explicitly after \n The text of the text line. The bounds of the line of text. Use Matrix transformation to move the draw position The context of the text. The font of the text. The text itself. The width of the box containing the text. The orientation of the text. Draws the text with matrix transformations. The context of the text. The font of the text. The text itself. The X position of the text. The Y position of the text. The width of the box containing the text. The orientation of the text. The new height of the text. Draws the text with pre-set breaks. The context of the text. The font of the text. The lines of text. The X position of the text. The Y position of the text. The width of the box containing the text. The orientation of the text. Gets the height of the font to calculate the height of the line. The font to calculate from. The height of the line. Gets the number of lines of text. The font of the text. The text itself. The path for the text. The height of the line The number of lines. Get the final height of the text. The font of the text. The text itself. The path for the text. The height of the line The final height of the text. Turns the supplied text into line of text constrained by supplied flow path and starting at supplied start coordinates The font of the text. The text of the lines. The flow direction of text. The offset start position for X The offset start position for Y The text broken up into lines. Turns the supplied text into line of text constrained by supplied flow path and starting at supplied start coordinates Contexts of the GUI. The text to be split Sets the general flow of text. The offset start position for X The offset start position for Y The text broken up into lines. lineX is set to 0 after the second line, lineY is advanced by line height for each line The context of the text. The preformatted lines of the text. The font of the text The orientation of text (Default: Left) Draws a line of text on the screen. The context of the text. The font of the text. The text to draw. The X offset for the text start position. (Default: 0) The Y offset for the text start position. (Default: 0) Whether or not to use TextPathMode. Text Texture Util constructor. The Client API. Takes a string of text and applies a texture to it. The text to texture. The font of the text. The width of the text. The height of the text. The background of the text. (default: none/null) The orientation of the text. (default: left) The texturized text. Takes a texture and applies some text to it. The text to texture. The font of the text. The width of the text. The height of the text. The texture to be loaded on to. The background of the text. (default: none/null) The orientation of the text. (default: left) Takes a string of text and applies a texture to it. The text to texture. The font of the text. The width of the text. The height of the text. The background of the text. (default: none/null) The texturized text. Takes a string of text and applies a texture to it. The text to texture. The font of the text. The background of the text. (default: none/null) The texturized text. Takes a texture and applies some text to it. The text to texture. The font of the text. The texture to be loaded on to. The background of the text. (default: none/null) Generates an unscaled text texture. The text to texture. The font of the text. The background of the text (Default: none/null) The loaded unscaled texture. Takes a string of text and applies a texture to it. The text to texture. The font of the text. The maximum width of the text. The background of the text. (default: none/null) The orientation of the text. (default: left) The texturized text. Vectors with w==0 are called vectors and with w==1 are called points Vectors with w==0 are called vectors and with w==1 are called points Creates a new copy of the array with removed Creates a new copy of array with element at index removed Creates a new copy of the array with appened to the end of the array Creates a new copy of the array with inserted at the given index Creates a new copy of the array with appended to the end of the array Creates a new copy of the array with appended to the end of the array Performs a Fisher-Yates shuffle in linear time or O(n) Performs a Fisher-Yates shuffle in linear time or O(n) A class to provide general helper functions for multi-threaded (asynchronous) operations For situations where a task should proceed only if another thread is not already working on the same task on the same object. For example, a main thread and a worker thread both iterating through a list of objects to process, this will ensure each object is processed exactly once.
Both threads should call this method before proceeding to do the task, both using an int field in each object to mark when the work has started.

Optionally, the referenced field can be a volatile int. It is not necessary for it to be volatile for correct Interlocked operation, but it can be a good idea if the value will be set or read elsewhere in the calling code. Pass by reference.
If this is volatile, it is safe to ignore the compiler warning "a reference to a volatile field will not be treated as volatile" Add several elements to dict Get value or defaultValue if key does not exists A faster implementation of a ProtoBuf serializer.
Note 1: for int and ushort and other primitives/structs, the default value of 0 will not be written (because the read value will be 0 anyhow, so not writing the 0 value makes no difference to what the reader eventually reads): except in arrays and other simple collections such as List, where 0 values will be written, so that the reader reads out all subsequent values in the array with the correct indexing
Note 2: for reference types including string, if the value is null then nothing will be written. A read collection may therefore be shorter than the written collection, if the written collection included null values: be careful serializing arrays of reference types, if necessary replace null values with something else prior to serialization. For convenience, one special exception here is arrays or lists of string: if a null string is in the array, FastSerializer will instead automatically write an empty string "". (We don't do that for other reference types because it is not necessarily clear what the default non-null value should be....) For long values Detected by the VintagestorySourcegen source generator, which replaces this default FastSerialize method with a source-generated version Indicates that the FastSerialize() method should call a custom method to serialize this field: the custom method being of the pattern FastSerializerDelegate Performs a Fisher-Yates shuffle in linear time or O(n) Performs a Fisher-Yates shuffle in linear time or O(n) Extracts hostname, port and password from given uri. Error will be non null if the uri is incorrect in some ways Uses ProtoBuf.NET to serialize T into bytes For performance, version using a reusable FastMemoryStream provided as a parameter.
(Caution: do not re-use the same stream in a nested way e.g. serializing individual elements within a larger object, as every call to this resets the stream) Uses ProtoBuf.Net to deserialize bytes into T Uses ProtoBuf.Net to deserialize bytes into existing object T Uses ProtoBuf.Net to deserialize bytes into T. Returns the default value if data is null Prints a single byte in hexadecimal. Potentially useful for logging issues relating to serialization, packets contents, etc Prints a byte array in hexadecimal. Potentially useful for logging issues relating to serialization, packets contents, etc IMPORTANT! This method should be used for every IndexOf operation in our code (except possibly in localised output to the user). This is important in order to avoid any culture-specific different results even when indexing GLSL shader code or other code strings, etc., or other strings in English, when the current culture is a different language (Known issue in the Thai language which has no spaces and treats punctuation marks as invisible, see https://github.com/dotnet/runtime/issues/59120)
See also: https://learn.microsoft.com/en-us/dotnet/standard/base-types/best-practices-strings IMPORTANT! This method should be used for every StartsWith operation in our code (except possibly in localised output to the user). This is important in order to avoid any culture-specific different results even when examining strings in English, when the user machine's current culture is a different language (Known issue in the Thai language which has no spaces and treats punctuation marks as invisible, see https://github.com/dotnet/runtime/issues/59120)
See also: https://learn.microsoft.com/en-us/dotnet/standard/base-types/best-practices-strings IMPORTANT! This method should be used for every EndsWith operation in our code (except possibly in localised output to the user). This is important in order to avoid any culture-specific different results even when examining strings in English, when the user machine's current culture is a different language (Known issue in the Thai language which has no spaces and treats punctuation marks as invisible, see https://github.com/dotnet/runtime/issues/59120)
See also: https://learn.microsoft.com/en-us/dotnet/standard/base-types/best-practices-strings This should be used for every string comparison when ordering strings (except possibly in localised output to the user) in order to avoid any culture specific string comparison issues in certain languages (worst in the Thai language which has no spaces and treats punctuation marks as invisible)
See also: https://learn.microsoft.com/en-us/dotnet/standard/base-types/best-practices-strings Convert the first character to an uppercase one A fast case-insensitive string comparison for "ordinal" culture i.e. plain ASCII comparison used for internal strings such as asset paths Removes diacritics and replaces quotation marks, guillemets and brackets with a blank space. Used to create a search friendly term Remove username from paths printed in log files Checks if two sorted arrays of tags have a common element. Must be sorted in ascending order Must be sorted in ascending order Checks if all requirement tags are in the sample. Must be sorted in ascending order Must be sorted in ascending order Checks if sample has at least one tag from each requirement group. Each group must be sorted in ascending order Must be sorted in ascending order Checks if sample contains all tags from at least one requirement group. Each group must be sorted in ascending order Must be sorted in ascending order Returns a new AssetLocation with the wildcards (*) being filled with the blocks other Code parts, if the wildcard matches. Example this block is trapdoor-up-north. search is *-up-*, replace is *-down-*, in this case this method will return trapdoor-down-north. Checks whether or not the wildcard matches for inCode, for example, returns true for wildcard rock-* and inCode rock-granite Extract the value matched by the wildcard. For exammple for rock-* and inCode rock-granite, this method will return 'granite' Returns null if the wildcard does not match Requires a pre-check that needle.Length is at least 1, and needleAsRegex has been pre-prepared If it starts with '^' interpret as a regex search string; otherwise special case, it represents the tailpiece of the needle following a single asterisk Returns the needle as a Regex string, if we are going to need to do a Regex search; alternatively returns some special case values
Special case: return value of null signifies no wildcard, look for exact matches only
Special case: return value of a non-regex string (not starting '^') represents the tailpiece part of the needle (the part following a single wildcard) Used to make explicit all places in the code where the default dimension, dimension 0, is assumed, in case we need to search and replace them later The dimension dedicated for storage of 'mini-dimensions', i.e. many separate 16k cubes of block space used for WorldEdit preview, vehicles etc The dimension dedicated for storage of blocks in an timeswitched alt-world, such as the Devastation The subdimension Id, within the MiniDimensions system, for the World Edit Blocks Preview dimension. Accessed client-side only This represents the XZ size of mini-dimensions (individual BlockAccessorMovables) within an overall dimension - we can pack 16 million of these into one dimension, which should be enough! Indicates whether a given BlockPos should not be ticked due to being in an unusual dimension, such as the preview minidimension Indicates whether a given BlockPos should not be ticked due to being in an unusual dimension, such as the preview minidimension Current branch of the game The games current version Assembly Info Version number in the format: major.minor.revision Whether this is a stable or unstable version Version number in the format: major.minor.revision[appendix] Version number in the format: major.minor.revision [release title] Assembly Info Version number in the format: major.minor.revision Version of the Mod API Version of the Network Protocol Version of the world generator - a change in version will insert a smoothed chunk between old and new version Version of the savegame database Version of the chunkdata compression for individual WorldChunks (0 is Deflate; 1 is ZSTD and palettised) Also affects compression of network packets sent "Version" of the block and item mapping. This number gets increased by 1 when remappings are needed Copyright notice Returns true if given version has the same major and minor version. Ignores revision. Returns true if given version has the same major and minor version. Ignores revision. Returns true if supplied version is the same or higher as the current version Returns true if supplied version is the same or higher as the reference version Returns true if supplied version is the higher as the reference version Contains some global constants and static values Prefix for all default asset locations Hard-enforced world size limit, above this the code may break Hard-enforced world height limit, above this the code may break. Now a hard-coded constant Used in various places if the dimension of a chunk is combined into the chunk's y value. Max. amount of "bones" for animated model. Limited by max amount of shader uniforms of around 60, but depends on the gfx card This value is overriden by ClientSettings.cs Max. amount of "bones" for color maps. Limited by max amount of shader uniforms, but depends on the gfx card Frame time for physics simulation Limits the amount of world time that can be simulated by the physics engine if the server is ticking slowly: if ticks are slower than this, entities will seem to slow down (viewed on client might even jump backwards)
Recommended range 0.1f to 0.4f A multiplier applied to the y motion of all particles affected by gravity. Attack range when using hands Multiplied to all motions and animation speeds Multiplier applied to the players movement motion Multiplier applied to the players jump motion Multiplier applied to the players sneaking motion Multiplier applied to the players sprinting motion Multiplier applied to entity motion while on the ground or in air Multiplier applied to entity motion while flying (creative mode) Multiplier applied to entity motion while walking in water Amount of gravity per tick applied to all entities affected by gravity Range in blocks at where this entity is simulated on the server (MagicNum.cs sets this value) Range in blocks a player can interact with blocks (break, use, place) Time in seconds for dropped items to remain when dropped after player death; overrides the despawn time set in item.json Set by the WeatherSimulation System in the survival mod at the players position Set by the SystemPlayerEnvAwarenessTracker System in the engine at the players position, once every second. 12 horizontal, 4 vertical search distance Set by the game client at the players position Set by the weather simulation system to determine if snowed variants of blocks should melt. Used a static var to improve performance and reduce memory usage Returns true if the player fell out of the world (which is map boundaries + 30 blocks in every direction) Returns true if the player fell out of the world (which is map boundaries + 30 blocks in every direction) These reserved characters or sequences should not be used in texture filenames or asset locations, they can mess up the BakedTexture system Channel name for the general chat Channel name for the general chat Channel name for the damage chat log Channel name for the info chat log Special channel key typically to reply a Command inside the same the channel the player sent it Special channel key typically to reply a Command inside the same the channel the player sent it Special channel key for message sent via server console Allowed characters for a player group name Bit of a helper thing for single player servers to display the correct entitlements The entity class used when spawning items in the world The entity class used when spawning players The entity class used when spawning falling blocks Default Itemstack attributes that should always be ignored during a stack.Collectible.Equals() comparison Global modifier to change the spoil rate of foods. Can be changed during run-time. The value is multiplied to the normal spoilage rate (default: 1) Global modifier to change the rate of player hunger. Can be changed during run-time. The value is multiplied to the normal spoilage rate (default: 1) Global modifier to change the damage melee attacks from creatures inflict. Can be changed during run-time. The value is multiplied to the normal damage value (default: 1) Global modifier to change the block breaking speed of all tools. Can be changed during run-time. The value is multiplied to the breaking speed (default: 1) Operating System Enum Information about the runningtime environment If TEXTURE_DEBUG_DISPOSE is set, the initial value set here will be overridden If VAO_DEBUG_DISPOSE is set, the initial value set here will be overridden Debug sound memory leaks. No ENV var If true, will print the stack trace on some of the blockaccessor if something attempts to get or set blocks outside of its available chunks If true, will print allocation trace whenever a new task was enqueued to the thread pool The current operating system The Env variable which contains the OS specific search paths for libarires This will only be set to true on Linux when the session is a wayland session This is needed so we can skip adding a app Icon or setting the cursor postion since those are not supported on wayland Whether we are in a dev environment or not Represents a service, which provides access to translated strings, based on key/value pairs read from JSON files. Gets the language code that this translation service caters for. A string, that contains the language code that this translation service caters for. Loads translation key/value pairs from all relevant JSON files within the Asset Manager. Loads only the vanilla JSON files, without dealing with mods, or resource-packs. The root assets path to load the vanilla files from. Loads the mod worldconfig language JSON files only. The assets path to load the mod files from. The mod domain to use when loading the files. Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns null if no results are found; otherwise returns the pre-formatted, translated value. Gets a translation for a given key. The key. The arguments to interpolate into the resulting string. Returns the key if no results are found; otherwise returns the pre-formatted, translated value. Retrieves a list of all translation entries within the cache. A dictionary of localisation entries. Gets the raw, unformatted translated value for the key provided. The key. Returns the key if no results are found; otherwise returns the unformatted, translated value. Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns the key if no results are found; otherwise returns the pre-formatted, translated value. Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns null if no results are found; otherwise returns the pre-formatted, translated value. Determines whether the specified key has a translation. The key. if set to true, the scan will include any wildcarded values. true if the specified key has a translation; otherwise, false. Determines whether the specified key has a translation. The key. if set to true, the scan will include any wildcarded values. if set to true, will add "Lang key not found" logging true if the specified key has a translation; otherwise, false. Specifies an asset manager to use, when the service has been lazy-loaded. The instance used within the sided API. Used to compile the regexes, to save time on the first 'actual' wildcard search - saves about 300ms Sets the loaded flag to false, so that the next lookup causes it to reload all translation entries Utility class for enabling i18n. Loads language entries from assets/[locale].json Kept legacy code structure and arguments for backwards compatibility. Gets the language code that this currently used to translate values. A string, that contains the language code that this currently used to translate values. Loads all translations The instance used within the sided API. The instance used within the sided API. The desired language Changes the current language for the game. The language code to set as the language for the game. Loads translation key/value pairs from all relevant JSON files within the Asset Manager. The instance used within the sided API. The instance used within the sided API. The language code to use as the default language. Loads only the vanilla JSON files, without dealing with mods, or resource-packs. The instance used within the sided API. The root assets path to load the vanilla files from. The language code to use as the default language. Loads the mod worldconfig language JSON files only. The assets path to load the mod files from. The mod domain to use when loading the files. The language code to use as the default language. Gets a translation entry for given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns the key as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Gets a translation entry for given key using given locale Gets a translation entry for given key using the current locale The key. The arguments to interpolate into the resulting string. Returns the key as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Gets a translation entry for given key using the current locale. Also tries the fallback key - useful if we change a key but not all languages updated yet Gets the raw, unformatted translated value for the key provided. The key. Returns the key as a default value, if no results are found; otherwise returns the unformatted, translated value. Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns the key as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Gets a translation entry for given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns null as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Retrieves a list of all translation entries within the cache. A dictionary of localisation entries. Determines whether the specified key has a translation. The key. if set to true, the scan will include any wildcarded values. true if the specified key has a translation; otherwise, false. A service, which provides access to translated strings, based on key/value pairs read from JSON files. Initialises a new instance of the class. The language code that this translation service caters for. The instance used within the sided API. The instance used within the sided API. Gets the language code that this translation service caters for. A string, that contains the language code that this translation service caters for. Loads translation key/value pairs from all relevant JSON files within the Asset Manager. Loads only the vanilla JSON files, without dealing with mods, or resource-packs. The root assets path to load the vanilla files from. Loads the mod worldconfig language JSON files only. The assets path to load the mod files from. The mod domain to use when loading the files. Sets the loaded flag to false, so that the next lookup causes it to reload all translation entries Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns the key as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Gets a translation for a given key. The key. The arguments to interpolate into the resulting string. Returns the key as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Retrieves a list of all translation entries within the cache. A dictionary of localisation entries. Gets the raw, unformatted translated value for the key provided. The key. Returns the key as a default value, if no results are found; otherwise returns the unformatted, translated value. Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns the key as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Determines whether the specified key has a translation. The key. if set to true, the scan will include any wildcarded values. true if the specified key has a translation; otherwise, false. Determines whether the specified key has a translation. The key. if set to true, the scan will include any wildcarded values. if set to true, will add "Lang key not found" logging true if the specified key has a translation; otherwise, false. Specifies an asset manager to use, when the service has been lazy-loaded. The instance used within the sided API. Gets a translation for a given key, if any matching wildcarded keys are found within the cache. The key. The arguments to interpolate into the resulting string. Returns null as a default value, if no results are found; otherwise returns the pre-formatted, translated value. Represents a List of nestable Attributes Will return null if given attribute does not exist Amount of elements in this Tree attribute Returns all values inside this tree attributes True if this attribute exists Similar to TryGetValue for a Dictionary Removes an attribute Creates a bool attribute with given key and value Creates an int attribute with given key and value Creates a long attribute with given key and value Creates a double attribute with given key and value Creates a float attribute with given key and value Creates a string attribute with given key and value Creates a byte[] attribute with given key and value Sets given item stack with given key Retrieves a bool or null if the key is not found Retrieves a bool or default value if key is not found Retrieves an int or null if the key is not found Retrieves an int or default value if key is not found Same as (int) Returns true/false, for whatever type of attribute is found for given key Retrieves an int, float, long or double value. Whatever attribute is found for given key Retrieves the value of given attribute, independent of attribute type Retrieves a long or null value if key is not found Retrieves a long or default value if key is not found Retrieves a float or null if the key is not found Retrieves a float or defaultvalue if key is not found Retrieves a double or null if key is not found Retrieves a double or defaultValue if key is not found Retrieves a string or defaultValue if key is not found Retrieves a byte array or defaultValue if key is not found Retrieves an itemstack or defaultValue if key is not found. Be sure to call stack.ResolveBlockOrItem() after retrieving it. Retrieves an attribute tree or null if key is not found Retrieves an attribute tree or adds it if key is not found. Throws an exception if the key does exist but is not a tree. Creates a deep copy of the attribute tree Merges trees (it will overwrite existing values) Returns a ITreeAttribute sorted alphabetically by key. Does not modify the existing ITreeAttribute An attribute from an attribute tree Whole tree will be resent Subtrees will be resent Marks the whole attribute tree as dirty, so that it will be resent to all connected clients. Does not trigger modified listeners (because it makes no sense and breaks things) Marks part of the attribute tree as dirty, allowing for a partial update of the attribute tree. Has no effect it the whole tree is already marked dirty. If more than 5 paths are marked dirty it will wipe the list of dirty paths and just marked the whole tree as dirty Equivalent to i++ within the TreeAttribute, i.e. it increases the stored value but returns the current read value When serialized, produces identical byte output to a ByteArrayAttribute. The difference is, for performance, this writes directly to the provided BinaryWriter stream
Intended to be deserialized to a ByteArrayAttribute Equivalent output as if a StringAttribute had been created within a TreeAttribute, and then that TreeAttribute was immediately serialized to the writer A datastructure to hold generic data for most primitives (int, string, float, etc.). But can also hold generic data using the ByteArrayAttribute + class serialization Will return null if given attribute does not exist Amount of elements in this Tree attribute Returns all values inside this tree attributes Set a value. Returns itself for method chaining True if this attribute exists Removes an attribute Creates a bool attribute with given key and value Creates an int attribute with given key and value
Side note: If you need this attribute to be compatible with deserialized json - use SetLong() Creates a long attribute with given key and value Creates a double attribute with given key and value Creates a float attribute with given key and value
Side note: If you need this attribute to be compatible with deserialized json - use SetDouble() Creates a byte[] attribute with given key and value Sets given item stack with given key Retrieves a bool or null if the key is not found Retrieves a double or null if key is not found Retrieves a float or null if the key is not found Retrieves a bool or default value if key is not found Retrieves an int or default value if key is not found Same as (int)GetDecimal(key, defValue); Retrieves an int, float, long or double value. Whatever attribute is found for given key, in aformentioned order. If its a string its converted to double Retrieves a double or defaultValue if key is not found Retrieves a float or defaultvalue if key is not found Retrieves a string attribute or defaultValue if key is not found Retrieves the value of given attribute, independent of attribute type Retrieves a string or defaultValue if key is not found Retrieves a byte array or defaultValue if key is not found Retrieves an attribute tree or null if key is not found Retrieves an attribute tree or adds it if key is not found. Throws an exception if the key does exist but is not a tree. Retrieves an itemstack or defaultValue if key is not found. Be sure to call stack.ResolveBlockOrItem() after retrieving it. Retrieves a long or default value if key is not found Retrieves a long or null value if key is not found Creates a deep copy of the attribute tree Returns true if given tree contains all of elements of this one, but given tree may contain also more elements. Individual node values are exactly matched. Returns true if given tree exactly matches this one Merges the sourceTree into the current one Exactly like ConcurrentDictionary except that Values is cached for performance, instead of building a new List each time Values is accessed

The cache is only guaranteed up to date if CachedConcurrentDictionary.TryAdd, .TryRemove or [] methods are used to modify the Dictionary otherwise the cache will be updated next time when one of those methods is used Just like CachedCuboidList except we use structs internally, for RAM access performance. We leave CachedCuboidList just as it is for mod backwards compatibility A fast implementation of IDictionary using arrays. Only suitable for small dictionaries, typically 1-20 entries.
Note that Add is implemented differently from a standard Dictionary, it does not check that the key is not already present (and does not throw an ArgumentException)
Additional methods AddIfNotPresent() and Clone() are provided for convenience. There are also additional convenient constructors It is calling code's responsibility to ensure the key being searched for is not null It is the calling code's responsibility to make sure that key is not null Represents a generic collection of key/value pairs that are ordered independently of the key and value. The type of the keys in the dictionary The type of the values in the dictionary Can only hold a limited amount of elements, discards oldest elements once the capacity is reached. Create a new limited dictionary with given maximum capacity Same as your normal C# Dictionary but ensures that the order in which the items are added is remembered. That way you can iterate over the dictionary with the insert order intact or set/get elements by index. Taken from http://www.codeproject.com/Articles/18615/OrderedDictionary-T-A-generic-implementation-of-IO Please be aware that this is not a very efficient implementation, recommed use only for small sets of data. Returns -1 if the key was not found Important: these are NOT ordered. The ordered values is obtained by .ValuesOrdered Adds values, but for performance does not replace any existing values which have the same key; that's fine for asset loading Return false if the set already contained this value; return true if the Add was successful Does not clear elements in Clear(), but only sets the Count to 0 When serializing to a buffer, indicates the count of bytes written so far When deserializing from a buffer, this is the full buffer length Used for Protobuf serialization if we need to go back and re-write a varInt value, for example the count of entities written Add four separate components, assumed to be signed int in the range -128 to +127 Return false if the set already contained this value; return true if the Add was successful Return false if the set already contained this value; return true if the Add was successful A datastructure to hold 3 dimensional data in the form of floats Can be used to perfrom trilinear interpolation between individual values A datastructure to hold 2 dimensional data in the form of ints. Can be used to perfrom bilinear interpolation between individual values Full Width and Length of the map (square) Top and Left padding Bottom and Right padding Width and Length of the map excluding any padding The parameters should both be in the range 0..1. They represent the position within the MapRegion. Calling code may need to use the (float)((double)val % 1.0) technique to ensure enough bits of precision when taking the fractional part (% 1.0), if val is large (for example a BlockPos in a 8Mx8M world) Elegant, yet somewhat inefficently designed (because wasteful with heap objects) wrapper class to abstract away the type-casting nightmare of JToken O.O Create a new instance of a JsonObject Create a new instance of a JsonObject Only present so that the Constructor with a sole null parameter has an unambiguous signature Access a tokens element with given key True if the token is not null True if the token has an element with given key Deserialize the token to an object of the specified type T Deserialize the token to an object of the specified type T, with the specified domain for any AssetLocation which needs to be parsed Turn the token into an array of JsonObjects Turn the token into a string If the conversion fails, this value is used instead Turn the token into an array If the conversion fails, this value is used instead Turn the token into a boolean If the conversion fails, this value is used instead Turn the token into an integer If the conversion fails, this value is used instead Turn the token into a float If the conversion fails, this value is used instead Turn the token into a double If the conversion fails, this value is used instead Calls token.ToString() True if the token is a JArray Turns the token into an IAttribute with all its child elements, if it has any.
Note: If you converting this to a tree attribute, a subsequent call to tree.GetInt() might not work because Newtonsoft.JSON seems to load integers as long, so use GetDecimal() or GetLong() instead. Similar things might happen with float<->double Turn a JArray into a primitive array Returns a deep clone Returns true if this object has the named bool attribute, and it is true Holds a limited amount of items, discards the lowest index item when an overflow happens Create a new list with a given maximum capacity Create a new list with a given maximum capacity Enqueue a single value with four separate components, assumed to be signed int in the range -128 to +127 Special method for ChunkIlluminator, if already present does not enqueue, but replaces only if value d (lowest 5 bits representing the spreadlight value) is larger Will return invalid data if called when Count <= 0: it is the responsibility of the calling code to check Count > 0 Will return invalid data if called when Count <= 0: it is the responsibility of the calling code to check Count > 0 Total size of the stack Pushes an element onto the end of the queue Wipes the buffer and resets the count If smaller than the old size, will discard oldest elements first A rotatable version of a cuboid. "selectionboxbytype": { "*-up": { "x1": 0, "y1": 0, "z1": 0, "x2": 1, "y2": 0.4, "z2": 1 }, "*-north": { "x1": 0, "y1": 0, "z1": 0, "x2": 1, "y2": 0.4, "z2": 1, "rotateZ": 90, "rotateY": 270 }, ... }, The cube's rotation around the X axis. The cube's rotation around the Y axis. The cube's rotation around the Z axis. The origin point for the object to rotate around. Measured in meters from zero, not percent. Suitable for up to 32 bool values, though normally used only for 6. Offers most of the methods available for a bool[], so can be dropped in to existing code Will return invalid data if called when Count <= 0: it is the responsibility of the calling code to check Count > 0 Will return invalid data if called when Count <= 0: it is the responsibility of the calling code to check Count > 0 List of entity tags meant to be used for fast comparisons. Restricts number of registered entity tags to 128 Maximum amount of different tags supported by tag array. Limited by total amount of bits in bit masks. Converts tag array into list of tag ids sorted in ascending order List of tag ids in ascending order Converts tag array into list of tags. Checks if this tag array contains all tags from Checks if this tag array contains at least on tag from each element of Checks if this tag array contains all tags from at least one element of Checks if two tag arrays have at least one common tag Checks if this tag array has at least one common tag with Pair of tag arrays that is used for implementation of tag inversion for entity ai tasks Checks if contains at least on tag from each rule from . /// Checks if contains all tags from at least one rule from . /// List of block tags meant to be used for fast comparisons. Restricts number of registered block tags to 256. Maximum amount of different tags supported by tag array. Limited by total amount of bits in bit masks. Converts tag array into list of tag ids sorted in ascending order List of tag ids in ascending order Converts tag array into list of tags. Checks if this tag array contains all tags from Checks if this tag array contains at least on tag from each element of Checks if this tag array contains all tags from at least one element of Checks if two tag arrays have at least one common tag Checks if this tag array has at least one common tag with Pair of tag arrays that is used for implementation of tag inversion Checks if contains at least on tag from each rule from . /// Checks if contains all tags from at least one rule from . /// List of item tags meant to be used for fast comparisons. Restricts number of registered item tags to 256. Maximum amount of different tags supported by tag array. Limited by total amount of bits in bit masks. Converts tag array into list of tag ids sorted in ascending order List of tag ids in ascending order Converts tag array into list of tags. Checks if this tag array contains all tags from Checks if this tag array contains at least on tag from each element of Checks if this tag array contains all tags from at least one element of Checks if two tag arrays have at least one common tag Checks if this tag array has at least one common tag with Pair of tag arrays that is used for implementation of tag inversion Checks if contains at least on tag from each rule from . /// Checks if contains all tags from at least one rule from . /// Same as your normal c# queue but ensures that every element is contained only once using a Hashset. Amount of elements in the queue Emptys the queue and the hashset Check if given item is contained. Uses the hashset to find the item. Adds an item to the queue Removes an item from the queue Returns the first item in the queue without removing it. 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. 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. The name of the property in DocFX. The summary of the property in DocFX. The name of the type, along with its full namespace. e.g. "System.Single" or "VintageStory.API.Common.CompositeShape". The text to put inside the "required" tag in DocFX. The text to put inside the "default" tag in DocFX. Use an empty string for none. 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. Converts between binary data and an Ascii85-encoded string. See Ascii85 at Wikipedia. Encodes the specified byte array in Ascii85. The bytes to encode. An Ascii85-encoded string representing the input byte array. Decodes the specified Ascii85 string into the corresponding byte array. The Ascii85 string. The decoded byte array. Represents one of the 6 faces of a cube and all it's properties. Uses a right Handed Coordinate System. See also http://www.matrix44.net/cms/notes/opengl-3d-graphics/coordinate-systems-in-opengl In short: North: Negative Z East: Positive X South: Positive Z West: Negative X Up: Positive Y Down: Negative Y All horizontal blockfacing flags combined All vertical blockfacing flags combined Faces towards negative Z Faces towards positive X Faces towards positive Z Faces towards negative X Faces towards positive Y Faces towards negative Y All block faces in the order of N, E, S, W, U, D All block faces in the order of N, E, S, W, U, D Packed ints representing the normal flags, left-shifted by 15 for easy inclusion in VertexFlags Array of horizontal faces (N, E, S, W) Array of the normals to the horizontal faces (N, E, S, W) Array of vertical faces (U, D) Array of horizontal faces in angle order (0°, 90°, 180°, 270°) => (E, N, W, S) The faces byte flag The index of the face (N=0, E=1, S=2, W=3, U=4, D=5) Index + 1 The angle index of the face (E = 0, N = 1, W = 2, S = 3) Returns a normal vector of this face. Classic iterating through these at a position x,y,z is unlikely to be dimension-aware, use BlockFacing.IterateThruFacingOffsets(pos) instead. Returns a normal vector of this face Returns a cuboid where either the width, height or length is zero which represents the min/max of the block 2D plane in 3D space Returns a normal vector of this face encoded in 6 bits/ bit 0: 1 if south or west bit 1: sign bit bit 2: 1 if up or down bit 3: sign bit bit 4: 1 if north or south bit 5: sign bit Normalized normal vector in format GL_INT_2_10_10_10_REV Normalized normal vector packed into 3x4=12 bytes total and bit shifted by 15 bits, for use in meshdata flags data Returns the center position of this face Returns the string north, east, south, west, up or down True if this face is N,E,S or W True if this face is U or D True if this face is N or S True if this face is N or S The normal axis of this vector. Returns the opposing face Returns the face if current face would be horizontally counter-clockwise rotated, only works for horizontal faces Returns the face if current face would be horizontally clockwise rotated, only works for horizontal faces Gets the Horizontal BlockFacing by applying the given angel If used on a UP or DOWN BlockFacing it will return it's current BlockFacing Applies a 3d rotation on the face and returns the face thats closest to the rotated face Rotates the face by given angle and returns the interpolated brightness of this face. Array of brightness values between 0 and 1 per face. In index order (N, E, S, W, U, D) Project pos onto the block face In 1.20+ this is the recommended technique for examining blocks on all sides of a BlockPos position, as it is dimension-aware
Successive calls to this when looping through the standard six BlockFacings will set pos to the relevant facing offset from the original position
NOTE: this modifies the fields of the pos parameter, which is better for heap usage than creating a new BlockPos object for each iteration
If necessary to restore the original blockPos value, call FinishIteratingAllFaces(pos) Restores the original value of pos, if we are certain we looped through ALLFACES using IterateThruFacingOffsets Note: if for any reason control might have exited the loop early, this cannot sensibly be used Rotates the face by given angle and returns the interpolated brightness of this face. Array of brightness values between 0 and 1 per face. In index order (N, E, S, W, U, D) Returns the face if code is 'north', 'east', 'south', 'west', 'north', 'up' or 'down'. Otherwise null. Returns the face if code is 'n', 'e', 's', 'w', 'n', 'u' or 'd'. Otherwise null. Returns the closest horizontal face from given angle (0 degree = east). Uses HORIZONTALS_ANGLEORDER Returns the closest horizontal face from given angle (0 degree = north for yaw!). Uses HORIZONTALS_ANGLEORDER Returns true if given byte flags contain given face Returns true if given byte flags contains a horizontal face A useful data structure when operating with block postions.
Valuable Hint: Make use of Copy() or the XXXCopy() variants where needed. A common pitfall is writing code like: BlockPos abovePos = pos.Up(); - with this code abovePos and pos will reference to the same object! The new BlockPos takes its dimension from the supplied y value, if the y value is higher than the DimensionBoundary (32768 blocks). This constructor is therefore dimension-aware, so long as the y parameter was originally based on .InternalY, including for example a Vec3d created originally from .InternalY Note - for backwards compatibility, this is *not* dimension-aware; explicitly set the dimension in the resulting BlockPos if you need to 0 = x, 1 = y, 2 = z Move the position vertically up Move the position vertically down Not dimension aware (but existing dimension in this BlockPos will be preserved) - use SetAndCorrectDimension() for dimension awareness Dimension aware version of Set() - use this if the Vec3d has the dimension embedded in the Y coordinate (e.g. Y == 65536+ for dimension 2) Dimension aware version of Set() - use this if there is a dimension embedded in the y coordinate (e.g. y == 65536+ for dimension 2) Sets XYZ to new values - not dimension aware (but existing dimension will be preserved) - use SetAndCorrectDimension() for dimension awareness Sets this BlockPos to the x,y,z values given, and returns a boolean stating if the existing values were already equal to x,y,z Returns true if the BlockPos already held these exact x, y, z values (the .Set operation has not changed anything)
Returns false if the .Set operation caused a change to the BlockPos Convert a block position to coordinates relative to the world spawn position. Note this is dimension unaware Returns the direction moved from the other blockPos, to get to this BlockPos Creates a copy of this blocks position with the x-position adjusted by - Creates a copy of this blocks position with the z-position adjusted by + Creates a copy of this blocks position with the x-position adjusted by + Creates a copy of this blocks position with the z-position adjusted by - Creates a copy of this blocks position with the y-position adjusted by - Creates a copy of this blocks position with the y-position adjusted by + Creates a copy of this blocks position Creates a copy of this blocks position, obtaining the correct dimension value from the Y value Offsets the position by given xyz Offsets the position by given xyz Offsets the position by given xyz vector Offsets the position by given xyz vector Offsets the position by given xyz vector Offsets the position into the direction of given block face Offsets the position into the direction of given block face Creates a copy of this blocks position and offsets it by given xyz Creates a copy of this blocks position and offsets it by given xyz Creates a copy of this blocks position and offsets it by given xyz Creates a copy of this blocks position and offsets it by given xyz Creates a copy of this blocks position and offsets it in the direction of given block face Creates a copy of this blocks position and offsets it in the direction of given block face Substract a position => you'll have the manhatten distance Substract a position => you'll have the manhatten distance Substract a position => you'll have the manhatten distance.
If used within a non-zero dimension the resulting BlockPos will be dimensionless as it's a distance or offset between two positions Creates a copy of this blocks position and divides it by given factor Iterate through NESW offsets from the starting position. See also BlockFacing.IterateThruFacingOffset Returns the Euclidean distance to between this and given position. Note if dimensions are different returns maximum value (i.e. infinite) Returns the Euclidean distance to between this and given position. Note this is dimension unaware Returns the squared Euclidean distance to between this and given position. Dimension aware Returns the squared Euclidean distance between the nearer edge of this blockpos (assumed 1 x 0.75 x 1 cube) and given position The 0.75 offset is because the "heat source" is likely to be above the base position of this block: it's approximate Note this is dimension unaware Returns the squared Euclidean horizontal distance to between this and given position Note this is dimension unaware Returns the manhatten distance to given position Returns the manhatten distance to given position Returns the manhatten distance to given position Note this is dimension unaware Returns true if the specified x,z is within a box the specified range around this position Note this is dimension unaware Creates a new instance of a Vec3d initialized with this position Note this is dimension unaware Creates a new instance of a Vec3i initialized with this position Note this is dimension unaware Like index3d used inside chunks, but the y value can have any value from 0 to worldheight, inside a chunk column Negative Z Positive X, negative Z Positive X Positive X, positive Z Positive Z Negative X, positive Z Negative X Negative X, negative Z Takes the entity positiona and motion and adds them, respecting any colliding blocks. The resulting new position is put into outposition Default 1 for the extra high collision boxes of fences Tests given cuboidf collides with the terrain. By default also checks if the cuboid is merely touching the terrain, set alsoCheckTouch to disable that. If given cuboidf collides with the terrain, returns the collision box it collides with. By default also checks if the cuboid is merely touching the terrain, set alsoCheckTouch to disable that. Tests given cuboidf collides with the terrain. By default also checks if the cuboid is merely touching the terrain, set alsoCheckTouch to disable that.
NOTE: currently not dimension-aware unless the supplied Vec3d pos is dimension-aware Originally intended to be a special version of CollisionTester for BehaviorControlledPhysics, which does not re-do the WalkBlocks() call and re-generate the CollisionBoxList more than once in the same entity tick
Currently in 1.20 the caching is not very useful when we loop through all entities sequentially - but empirical testing shows it is actually faster not to cache Specifies types of per-pixel color blending. Many utility methods and fields for working with colors Amount of bits per block that are available to store the hue value Amount of bits per block that are available to store the saturation value Amount of bits per block that are available to store the brightness value 255 << 24 ~(255 << 24) White opaque color as normalized float values (0..1) White opaque color as normalized float values (0..1) White opaque color as normalized float values (0..1) White opaque color as normalized float values (0..1) White opaque argb color as bytes (0..255) White opaque ahsv color as bytes (0..255) White opaque argb color White opaque AHSV color Black opaque rgb color Black opaque rgb color Black opaque rgb color White opaque color as normalized float values (0..1) Reverses the RGB channels, but leaves alpha untouched. Basically turns RGBA into BGRA and vice versa Reverses the RGB channels, but leaves alpha untouched. Basically turns RGBA into BGRA and vice versa Splits up a 32bit int color into 4 1 byte components, in BGRA order (Alpha channel at the highest 8 bits) Splits up a 32bit int color into 4 1 byte components, in RGBA order Returns a 4 element rgb float with values between 0..1 Returns a 4 element rgb float with values between 0..1 Care: the returned value is in true RGBA order, not BGRA as used for example by VS particle system. Therefore, depending on use, calling code may need to exchange the r and b parameters to see correct colors rendered in-game. Returns a 4 element rgb double with values between 0..1 Multiplies two colors together: c=(a*b)/255 Multiplies two colors together c=(a*b)/255 Multiplies a float value to the rgb color channels, leaves alpha channel unchanged Multiplies a float value to the rgb color channels, leaves alpha channel unchanged. Makes sure the multiplied value stays within the 0..255 range Multiplies a float value to the rgb color channels Multiplies a float value to every color channel including the alpha component. Averages several colors together in RGB space Overlays rgb2 over rgb1 When c2weight = 0 resulting color is color1, when c2weight = 1 then resulting color is color2 Resulting color alpha value is 100% color1 alpha Overlays rgb1 on top of rgb2, based on their alpha values Combines two HSV colors by converting them to rgb then back to hsv. Uses the brightness as a weighting factor. Also leaves the brightness at the max of both hsv colors. Combined HSV Color Removes HSV2 from HSV1 by converting them to rgb then back to hsv. Uses the brightness as a weighting factor. Leaves brightness unchanged. Pack the 4 color components into a single ARGB 32bit int Returns alpha value of given color Returns red value of given color Returns green value of given color Returns blue value of given color Returns human a readable string of given color Turn a string hex color (with #) into a single int Turn a color int into its string hex version, including preceeding # Turn a color int into its string hex version, including preceeding #, including alpha channel Parses a hex string as an rgb(a) color and returns an array of colors normalized fom 0..1 for use with Cairo. E.g. turns #FF0000 into double[1, 0, 0, 1] and #00FF00CC into double[0, 1, 0, 0.8] Converts given RGB values into it's respective HSV Representation (all values in range of 0-255) In the result, V is the MOST significant byte Converts given RGB value into it's respective HSV Representation (all values in range of 0-255) In the parameter, R is the most significant byte i.e. this is for RGB In the result, V is the LEAST significant byte Converts given RGB values into it's respective HSV Representation (all values in range of 0-255) Converts given HSV value into it's respective RGB Representation (all values in range of 0-255) R is the most significant byte i.e. this is RGB Converts given HSV values into it's respective RGB Representation (all values in range of 0-255) R is the most significant byte i.e. this is RGB Returns a fully opaque gray color with given brightness Converts given HSB values into it's respective ARGB Representation (all values in range of 0-255, alpha always 255) R is the LEAST significant byte i.e. the result is BGR Converts given HSV values into its respective ARGB Representation (all values in range of 0-255) R is the LEAST significant byte i.e. the result is BGR Converts given HSV values into its respective RGB representation (all values in range of 0-255) R is the first byte in the resulting array Converts given HSVA values into its respective RGBA Representation (all values in range of 0-255) R is the first byte in the resulting array Converts HSV (extracted from light and lightSat) to RGBA Implementation of CRC-32. This class supports several convenient static methods returning the CRC as UInt32. From https://github.com/force-net/Crc32.NET Initializes a new instance of the class. Computes CRC-32 from multiple buffers. Call this method multiple times to chain multiple buffers. Initial CRC value for the algorithm. It is zero for the first buffer. Subsequent buffers should have their initial value set to CRC value returned by previous call to this method. Input buffer with data to be checksummed. Offset of the input data within the buffer. Length of the input data in the buffer. Accumulated CRC-32 of all buffers processed so far. Computes CRC-3C from multiple buffers. Call this method multiple times to chain multiple buffers. Initial CRC value for the algorithm. It is zero for the first buffer. Subsequent buffers should have their initial value set to CRC value returned by previous call to this method. Input buffer containing data to be checksummed. Accumulated CRC-32 of all buffers processed so far. Computes CRC-32 from input buffer. Input buffer with data to be checksummed. Offset of the input data within the buffer. Length of the input data in the buffer. CRC-32 of the data in the buffer. Computes CRC-32 from input buffer. Input buffer containing data to be checksummed. CRC-32 of the buffer. Resets internal state of the algorithm. Used internally. Appends CRC-32 from given buffer Computes CRC-32 from Represents a three dimensional axis-aligned cuboid using two 3d coordinates. Used for collision and selection withes. MaxX-MinX MaxY-MinY MaxZ-MinZ Sets the minimum and maximum values of the cuboid Sets the minimum and maximum values of the cuboid Sets the minimum and maximum values of the cuboid Sets the cuboid to the selectionBox, translated by vec Sets the cuboid to the selectionBox, translated by (dX, dY, dZ) Adds the given offset to the cuboid Adds the given offset to the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Grows the cuboid so that it includes the given block Grows the cuboid so that it includes the given block Returns the shortest distance between given point and any point inside the cuboid Returns the shortest distance between given point and any point inside the cuboid Returns the shortest vertical distance to any point between this and given cuboid Returns the shortest distance to any point between this and given cuboid Returns the shortest distance to any point between this and given cuboid Returns the shortest distance to any point between this and given cuboid Returns the shortest horizontal distance to any point between this and given cuboid Returns the shortest horizontal distance to any point between this and given coordinate Returns the shortest distance between given point and any point inside the cuboid Returns a new x coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new y coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new z coordinate that's ensured to be outside this cuboid. Used for collision detection. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it makes any sense to use this for other rotations than 90 degree intervals. Returns a new cuboid offseted by given position Returns a new cuboid offseted by given position If the given cuboid intersects with this cuboid If the given cuboid intersects with this cuboid If the given cuboid intersects with this cuboid If the given cuboid intersects with this cuboid If the given cuboid intersects with this cuboid If the given cuboid intersects with this cuboid Creates a copy of the cuboid Represents a three dimensional axis-aligned cuboid using two 3D coordinates. Used for collision and selection boxes. Start X Pos Start Y Pos Start Z Pos End X Pos End Y Pos End Z Pos This is equivalent to width so long as X2 > X1, but could in theory be a negative number if the box has its corners the wrong way around This is equivalent to height so long as Y2 > Y1, but could in theory be a negative number if the box has its corners the wrong way around This is equivalent to length so long as Z2 > Z1, but could in theory be a negative number if the box has its corners the wrong way around True when all values are 0 Sets the minimum and maximum values of the cuboid Sets the minimum and maximum values of the cuboid Adds the given offset to the cuboid Adds the given offset to the cuboid Substractes the given offset to the cuboid Substractes the given offset to the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Grows the cuboid so that it includes the given block Grows the cuboid so that it includes the given block Returns the shortest distance between given point and any point inside the cuboid Returns the shortest distance between given point and any point inside the cuboid Returns a new x coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new y coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new z coordinate that's ensured to be outside this cuboid. Used for collision detection. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Returns a new double precision cuboid offseted by given position Returns a new cuboid offseted by given position Returns a new cuboid offseted by given position Returns a new cuboid offseted by given position Expands this in the given direction by amount d Creates a copy of the cuboid Returns a new cuboid with default size 1 width/height/length Makes sure the collisionbox coords are multiples of 0.0001 A 3D cuboid, created out of integers. Sets the minimum and maximum values of the cuboid Sets the minimum and maximum values of the cuboid Adds the given offset to the cuboid Adds the given offset to the cuboid Substractes the given offset to the cuboid Divides the given value to the cuboid Substractes the given offset to the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns if the given entityPos is inside the cuboid Grows the cuboid so that it includes the given block Grows the cuboid so that it includes the given block Returns the shortest distance between given point and any point inside the cuboid Returns the shortest distance between given point and any point inside the cuboid Returns the shortest distance to any point between this and given cuboid Returns a new x coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new y coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new z coordinate that's ensured to be outside this cuboid. Used for collision detection. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Returns a new cuboid offseted by given position Returns a new cuboid offseted by given position If the given cuboid intersects with this cubiod Ignores the y-axis If the given cuboid intersects with or is adjacent to this cubiod Creates a copy of the cuboid Returns true if supplied cuboid is directly adjacent to this one Sets the minimum and maximum values of the cuboid Sets the minimum and maximum values of the cuboid Adds the given offset to the cuboid Adds the given offset to the cuboid Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Grows the cuboid so that it includes the given block Returns the shortest distance between given point and any point inside the cuboid Returns the shortest distance between given point and any point inside the cuboid Returns the shortest distance between given point and any point inside the cuboid Returns a new x coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new y coordinate that's ensured to be outside this cuboid. Used for collision detection. Returns a new z coordinate that's ensured to be outside this cuboid. Used for collision detection. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Performs a 3-dimensional rotation on the cuboid and returns a new axis-aligned cuboid resulting from this rotation. Not sure it it makes any sense to use this for other rotations than 90 degree intervals. Returns a new cuboid offseted by given position Returns a new cuboid offseted by given position Creates a copy of the cuboid Represents an axis in the cartesian coordinate system West or East Up or down North or South Used to define how variant types interact with each other to create unique objects. This variant type will ignore all other variant types. Each state is appended onto the object's code, without any other variant types. Default behavior - This variant's states will be enumerated with all other variant states that have this combination. This variant's states will be enumerated only with the selected variant group. You must select another variant code using the 'onVariant' property. Used for EvolvingNatFloat value transforms y = firstval y = firstval + factor * seq y = factor > 0 ? Math.Min(0, firstval + factor * seq) : Math.Max(0, firstval + factor * seq) firstval - firstval / Math.Abs(firstval) * factor * seq firstval + firstval / Math.Abs(firstval) * factor * seq firstval + Math.Sign(factor) * (factor * seq) * (factor * seq) firstval + 1f / (1f + factor * seq) firstval + (float)Math.Sqrt(factor * seq) firstval + GameMath.FastSin(factor * seq) firstval * GameMath.Min(5 * Math.Abs(GameMath.FastSin(factor * seq)), 1) firstval + GameMath.FastCos(factor * seq) firstval + GameMath.SmoothStep(factor * seq) A number generator whose return value changes over time, parametrized by a transform function and some constants The type of function to use as this value changes. A scale factor for the value during the transformation function. The maximum value this random value can return. The sequence should always run from 0 to n A large set of useful game mathematics functions 360° 180° 90° The sine of the angle, expressed as a float. The angle is in radians The cosine of the angle, expressed as a float. The angle is in radians Faster Sin at the cost of lower accuracy Faster Cos at the cost of lower accuracy Faster Sin at the cost of lower accuracy Faster Cos at the cost of lower accuracy Force val to be inside a certain range Force val to be inside a certain range Force val to be inside a certain range Force val to be inside a certain range Force val to be outside a certain range C#'s %-Operation is actually not modulo but remainder, so this is the actual modulo function that ensures positive numbers as return value C#'s %-Operation is actually not modulo but remainder, so this is the actual modulo function that ensures positive numbers as return value C#'s %-Operation is actually not modulo but remainder, so this is the actual modulo function that ensures positive numbers as return value Treats given value as a statistical average. Example: 2.1 will turn into 2 90% of the times and into 3 10% of times. Treats given value as a statistical average. Example: 2.1 will turn into 2 90% of the times and into 3 10% of times. Returns the shortest distance between 2 angles See also https://stackoverflow.com/a/14498790/1873041 Returns the shortest distance between 2 angles See also https://stackoverflow.com/a/14498790/1873041 For angles in radians, normalise to the range 0 to 2 * PI and also, if barely close to a right angle, set it to a right angle (fixes loss of precision after multiple rotation operations etc.) Returns the smallest number, ignoring the sign of either value. Examples:
Smallest(1, 3) returns 1 Smallest(-20, 3) returns 3 Returns the smallest number, ignoring the sign of either value Returns the shortest distance between 2 values that are cyclical (e.g. angles, daytime hours, etc.) See also https://stackoverflow.com/a/14498790/1873041 Returns the shortest distance between 2 values that are cyclical (e.g. angles, daytime hours, etc.) See also https://stackoverflow.com/a/14498790/1873041 Generates a gaussian blur kernel to be used when blurring something Does linear interpolation on a 2d map for each of the 4 bytes individually (e.g. RGBA color). It's basically a bilinear zoom of an image like you know it from common image editing software. Only intended for square images. The resulting map will be without any paddding (also requires at least 1 padding at bottom and left side) Linear Interpolates one selected bytes of the 4 ints 0, 1, 2 or 3 Linear Interpolates one selected bytes of the 4 ints 0, 1, 2 or 3 Linear Interpolates the bytes of the int individually (i.e. interpolates RGB values individually) Linear Interpolates the lower 3 bytes of the int individually (i.e. interpolates RGB values individually) Smoothstep Interpolates the lower 3 bytes of the int individually (i.e. interpolates RGB values individually) Linear Interpolates the lower 3 bytes of the int individually (i.e. interpolates RGB values individually) Linear Interpolates the 4 bytes of the int individually (i.e. interpolates RGB values individually) Linear Interpolates a single byte Basic Bilinear Lerp Basic Bilinear Lerp Same as Same as Basic Lerp Basic Lerp Smooth Interpolation using inlined Smoothstep Unlike the other implementation here, which uses the default "uniform" treatment of t, this computation is used to calculate the same values but introduces the ability to "parameterize" the t values used in the calculation. This is based on Figure 3 from http://www.cemyuksel.com/research/catmullrom_param/catmullrom.pdf the actual interpolation ratio from 0 to 1 representing the position between p1 and p2 to interpolate the value. An array of double values of length 4, where interpolation occurs from p1 to p2. An array of time measures of length 4, corresponding to each p value. Better Lerp but more CPU intensive, see also https://en.wikipedia.org/wiki/Smoothstep Better Lerp but more CPU intensive, see also https://en.wikipedia.org/wiki/Smoothstep Better Lerp but more CPU intensive, see also https://en.wikipedia.org/wiki/Smoothstep Better Lerp but more CPU intensive, see also https://en.wikipedia.org/wiki/Smoothstep Better Lerp but more CPU intensive, see also https://en.wikipedia.org/wiki/Smoothstep. x must be in range of 0..1 Returns a value between 0..1. Returns 0 if val is smaller than left or greater than right. For val == (left+right)/2 the return value is 1. Every other value is a linear interpolation based on the distance to the middle value. Ascii art representation: 1 | /\ | / \ 0.5| / \ | / \ | / \ 0 __/__________\______ left right Returns a value between 0..1. Returns 0 if val is smaller than left or greater than right. For val == (left+right)/2 the return value is 1. Every other value is a linear interpolation based on the distance to the middle value. Ascii art representation: 1 | /\ | / \ 0.5| / \ | / \ | / \ 0 __/__________\______ left right Same as TriangleStep but skipping the step to calc mid and range. Pretty much taken directly from the string.GetHashCode() implementation, but on these methods the documentation states: "You should never persist or use a hash code outside the application domain in which it was created, [...]." Hence, this is one basic 32bit bit implementation that can be used in a platform independent, persistent way. See also https://msdn.microsoft.com/en-us/library/system.security.cryptography.md5%28v=vs.110%29.aspx A single iteration of Bob Jenkins' One-At-A-Time hashing algorithm - optimised version for the vector hashes A single iteration of Bob Jenkins' One-At-A-Time hashing algorithm. Bob Jenkins' One-At-A-Time hashing algorithm Bob Jenkins' One-At-A-Time hashing algorithm. Fast, but not very random. Bob Jenkins' One-At-A-Time hashing algorithm. Fast, but not very random. Bob Jenkins' One-At-A-Time hashing algorithm. Fast, but not very random. Bob Jenkins' One-At-A-Time hashing algorithm. Fast, but not very random. Bob Jenkins' One-At-A-Time hashing algorithm. Fast, but not very random. Bob Jenkins' One-At-A-Time hashing algorithm. Fast, but not very random. A really bad, but very fast hashing method. A not so fast, but higher quality than oaatHash(). See also https://en.wikipedia.org/wiki/MurmurHash. Includes a modulo operation. A not so fast, but higher quality than oaatHash(). See also https://en.wikipedia.org/wiki/MurmurHash Quasirandom sequence by Martin Roberts (http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/) Quasirandom sequence by Martin Roberts (http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/) Quasirandom sequence by Martin Roberts (http://extremelearning.com.au/unreasonable-effectiveness-of-quasirandom-sequences/) Assigns the value of x1 to x2 and vice versa Assigns the value of x1 to x2 and vice versa Performs a Fisher-Yates shuffle in linear time or O(n) Performs a Fisher-Yates shuffle in linear time or O(n) Performs a Fisher-Yates shuffle in linear time or O(n) Plot a 3d line, see also http://members.chello.at/~easyfilter/bresenham.html Plot a 3d line, see also http://members.chello.at/~easyfilter/bresenham.html Plot a 2d line, see also http://members.chello.at/~easyfilter/bresenham.html Map a value from one range to another Returns 0..max-1 An lcg random generator, particularly suitable for worldgen See also https://en.wikipedia.org/wiki/Linear_congruential_generator Square root of int.MaxValue, used for generating floats with approximately 15 bits / 4.5 decimal digits of precision Square root of int.MaxValue, used for generating floats with approximately 15 bits / 4.5 decimal digits of precision Initialize random with given seed Initialize random with no seed. Use SetWorldSeed() to initialize Sets given seed Initializes a position dependent seed, if required Initializes a position dependent seed, if required Returns a pseudo random number from 0 - max (excluding max) Returns a random number from 0 - int.MaxValue (inclusive) Returns a random number from 0.0F - 1.0F (inclusive) Returns a random number from -1.0F - 1.0F (inclusive) with a bias towards the zero value (triangle graph, similar to how rolling two 6-sided dice and adding the result is most likely to yield 7)
Precise to better than 15 binary digits / better than 4 significant figures in decimal Returns a random number from 0.0 - 1.0 (inclusive) 2x2 Matrix Creates a new identity mat2 Returns a new 2x2 matrix Creates a new mat2 initialized with values from an existing matrix Returns a new 2x2 matrix matrix to clone Copy the values from one mat2 to another Returns output the receiving matrix the source matrix Set a mat2 to the identity matrix Returns output the receiving matrix Transpose the values of a mat2 Returns output the receiving matrix the source matrix Inverts a mat2 Returns output the receiving matrix the source matrix Calculates the adjugate of a mat2 Returns output the receiving matrix the source matrix Calculates the determinant of a mat2 Returns determinant of a the source matrix Multiplies two mat2's Returns output the receiving matrix the first operand the second operand Alias for {@link mat2.multiply} Rotates a mat2 by the given angle Returns output the receiving matrix the matrix to rotate the angle to rotate the matrix by Scales the mat2 by the dimensions in the given vec2 Returns output the receiving matrix the matrix to rotate the vec2 to scale the matrix by 2x3 Matrix * A mat2d contains six elements defined as: * 
            * [a, b,
            *  c, d,
            *  tx,ty]
            *
* This is a short form for the 3x3 matrix: * 
            * [a, b, 0
            *  c, d, 0
            *  tx,ty,1]
            *
* The last column is ignored so the array is shorter and operations are faster. Creates a new identity mat2d Returns a new 2x3 matrix Creates a new mat2d initialized with values from an existing matrix Returns a new 2x3 matrix matrix to clone Copy the values from one mat2d to another Returns output the receiving matrix the source matrix Set a mat2d to the identity matrix Returns output the receiving matrix Inverts a mat2d Returns output the receiving matrix the source matrix Calculates the determinant of a mat2d Returns determinant of a the source matrix Multiplies two mat2d's Returns output the receiving matrix the first operand the second operand Alias for {@link mat2d.multiply} @function Rotates a mat2d by the given angle Returns output the receiving matrix the matrix to rotate the angle to rotate the matrix by Scales the mat2d by the dimensions in the given vec2 Returns output the receiving matrix the matrix to translate the vec2 to scale the matrix by Translates the mat2d by the dimensions in the given vec2 Returns output the receiving matrix the matrix to translate the vec2 to translate the matrix by ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** 4x4 Matrix Math Creates a new identity mat4 0 4 8 12 1 5 9 13 2 6 10 14 3 7 11 15 {mat4} a new 4x4 matrix Creates a new mat4 initialized with values from an existing matrix a matrix to clone {mat4} a new 4x4 matrix Copy the values from one mat4 to another {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Set a mat4 to the identity matrix {mat4} out the receiving matrix {mat4} out Transpose the values of a mat4 {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Inverts a mat4 {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Calculates the adjugate of a mat4 {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Calculates the determinant of a mat4 {mat4} a the source matrix {Number} determinant of a Multiplies two mat4's {mat4} out the receiving matrix {mat4} a the first operand {mat4} b the second operand {mat4} out Multiplies two mat4's {mat4} out the receiving matrix {mat4} a the first operand {mat4} b the second operand {mat4} out mat4.multiply mat4.multiply If we have a translation-only matrix - one with no rotation or scaling - return true. If the matrix includes some scaling or rotation components, return false.
The identity matrix returns true here because there is no scaling or rotation, even though the translation is zero in that special case. true if a simple translation matrix was found, otherwise false Translate a mat4 by the given vector {mat4} out the receiving matrix {mat4} a the matrix to translate {vec3} v vector to translate by {mat4} out Translate a mat4 by the given vector {mat4} out the receiving matrix {mat4} a the matrix to translate {vec3} v vector to translate by {mat4} out Scales the mat4 by the dimensions in the given vec3 {mat4} out the receiving matrix {mat4} a the matrix to scale {vec3} v the vec3 to scale the matrix by {mat4} out Rotates a mat4 by the given angle {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {vec3} axis the axis to rotate around {mat4} out Rotates a mat4 by the given angle Rotates a matrix by the given angle around the X axis {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {mat4} out Rotates a matrix by the given angle around the Y axis {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {mat4} out Rotates a matrix by the given angle around the Z axis {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {mat4} out Creates a matrix from a quaternion rotation and vector translation This is equivalent to (but much faster than): mat4.identity(dest); mat4.translate(dest, vec); var quatMat = mat4.create(); quat4.toMat4(quat, quatMat); mat4.multiply(dest, quatMat); {mat4} out mat4 receiving operation result {quat4} q Rotation quaternion {vec3} v Translation vector {mat4} out Calculates a 4x4 matrix from the given quaternion {mat4} out mat4 receiving operation result {quat} q Quaternion to create matrix from {mat4} out Generates a frustum matrix with the given bounds {mat4} out mat4 frustum matrix will be written into {Number} left Left bound of the frustum {Number} right Right bound of the frustum {Number} bottom Bottom bound of the frustum {Number} top Top bound of the frustum {Number} near Near bound of the frustum {Number} far Far bound of the frustum {mat4} out Generates a perspective projection matrix with the given bounds {mat4} out mat4 frustum matrix will be written into {number} fovy Vertical field of view in radians {number} aspect Aspect ratio. typically viewport width/height {number} near Near bound of the frustum {number} far Far bound of the frustum {mat4} out Generates a orthogonal projection matrix with the given bounds {mat4} out mat4 frustum matrix will be written into {number} left Left bound of the frustum {number} right Right bound of the frustum {number} bottom Bottom bound of the frustum {number} top Top bound of the frustum {number} near Near bound of the frustum {number} far Far bound of the frustum {mat4} out Generates a look-at matrix with the given eye position, focal point, and up axis {mat4} out mat4 frustum matrix will be written into {vec3} eye Position of the viewer {vec3} center Point the viewer is looking at {vec3} up vec3 pointing up {mat4} out Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication Returns a new vec4 vector Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication 4x4 Matrix Math Creates a new identity mat4 0 4 8 12 1 5 9 13 2 6 10 14 3 7 11 15 {mat4} a new 4x4 matrix Creates a new mat4 initialized with values from an existing matrix a matrix to clone {mat4} a new 4x4 matrix Copy the values from one mat4 to another {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Set a mat4 to the identity matrix {mat4} out the receiving matrix {mat4} out Set a mat4 to the identity matrix with a scale applied {mat4} out the receiving matrix {mat4} out Transpose the values of a mat4 {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Inverts a mat4 {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Calculates the adjugate of a mat4 {mat4} out the receiving matrix {mat4} a the source matrix {mat4} out Calculates the determinant of a mat4 {mat4} a the source matrix {Number} determinant of a Multiplies two mat4's {mat4} out the receiving matrix {mat4} a the first operand {mat4} b the second operand {mat4} out mat4.multiply Translate a mat4 by the given vector {mat4} out the receiving matrix {mat4} a the matrix to translate {vec3} v vector to translate by {mat4} out Translate a mat4 by the given vector {mat4} out the receiving matrix {mat4} a the matrix to translate {vec3} v vector to translate by {mat4} out Scales the mat4 by the dimensions in the given vec3 {mat4} out the receiving matrix {mat4} a the matrix to scale {vec3} v the vec3 to scale the matrix by {mat4} out Scales the mat4 by the dimensions in the given vec3 {mat4} out the receiving matrix {mat4} a the matrix to scale {mat4} out Rotates a mat4 by the given angle {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {vec3} axis the axis to rotate around {mat4} out Rotates a matrix by the given angle around the X axis {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {mat4} out Rotates a matrix by the given angle around the Y axis {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {mat4} out Rotates a matrix by the given angle around the Z axis {mat4} out the receiving matrix {mat4} a the matrix to rotate {Number} rad the angle to rotate the matrix by {mat4} out Provides a composite rotation matrix, equivalent to RotateX followed by RotateY followed by RotateZ
Here we work on a Span (which may be on the stack) for higher performance Creates a matrix from a quaternion rotation and vector translation This is equivalent to (but much faster than): mat4.identity(dest); mat4.translate(dest, vec); var quatMat = mat4.create(); quat4.toMat4(quat, quatMat); mat4.multiply(dest, quatMat); {mat4} out mat4 receiving operation result {quat4} q Rotation quaternion {vec3} v Translation vector {mat4} out Calculates a 4x4 matrix from the given quaternion {mat4} out mat4 receiving operation result {quat} q Quaternion to create matrix from {mat4} out Generates a frustum matrix with the given bounds {mat4} out mat4 frustum matrix will be written into {Number} left Left bound of the frustum {Number} right Right bound of the frustum {Number} bottom Bottom bound of the frustum {Number} top Top bound of the frustum {Number} near Near bound of the frustum {Number} far Far bound of the frustum {mat4} out Generates a perspective projection matrix with the given bounds {mat4} out mat4 frustum matrix will be written into {number} fovy Vertical field of view in radians {number} aspect Aspect ratio. typically viewport width/height {number} near Near bound of the frustum {number} far Far bound of the frustum {mat4} out Generates a orthogonal projection matrix with the given bounds {mat4} out mat4 frustum matrix will be written into {number} left Left bound of the frustum {number} right Right bound of the frustum {number} bottom Bottom bound of the frustum {number} top Top bound of the frustum {number} near Near bound of the frustum {number} far Far bound of the frustum {mat4} out Generates a look-at matrix with the given eye position, focal point, and up axis {mat4} out mat4 frustum matrix will be written into {vec3} eye Position of the viewer {vec3} center Point the viewer is looking at {vec3} up vec3 pointing up {mat4} out Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication Returns a new vec4 vector Used for vec3 representing a direction or normal - as a vec4 this would have the 4th element set to 0, so that applying a matrix transform with a translation would have *no* effect Used for vec3 representing a direction or normal - as a vec4 this would have the 4th element set to 0, so that applying a matrix transform with a translation would have *no* effect Used for vec3 representing an x,y,z position - as a vec4 this would have the 4th element set to 1, so that applying a matrix transform with a translation would have an effect The offset is used to index within the original and output arrays - e.g. in MeshData.xyz Used for vec3 representing an x,y,z position - as a vec4 this would have the 4th element set to 1, so that applying a matrix transform with a translation would have an effect The offset is used to index within the original and output arrays - e.g. in MeshData.xyz The origin is the origin for the rotation Used for vec3 representing an x,y,z position - as a vec4 this would have the 4th element set to 1, so that applying a matrix transform with a translation would have an effect Used for Vec3f representing a direction or normal - as a vec4 this would have the 4th element set to 0, so that applying a matrix transform with a translation would have *no* effect Used for x,y,z representing a direction or normal - as a vec4 this would have the 4th element set to 0, so that applying a matrix transform with a translation would have *no* effect Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication Multiply the matrix with a vec4. Reference: http://mathinsight.org/matrix_vector_multiplication ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** Don't use this class unless you need it to interoperate with Mat4d Creates a new, empty vec3 Returns {vec3} a new 3D vector. Creates a new vec3 initialized with values from an existing vector. Returns {vec3} a new 3D vector vector to clone Creates a new vec3 initialized with the given values. Returns {vec3} a new 3D vector Copy the values from one vec3 to another. Returns {vec3} out the receiving vector the source vector Set the components of a vec3 to the given values. Returns {vec3} out the receiving vector Adds two vec3's. returns {vec3} out Subtracts vector b from vector a. Returns {vec3} out the first operand the second operand Multiplies two vec3's Divides two vec3's Returns the minimum of two vec3's Returns the maximum of two vec3's Scales a vec3 by a scalar number Adds two vec3's after scaling the second operand by a scalar value Calculates the euclidian distance between two vec3's. Returns {Number} distance between a and b Calculates the squared euclidian distance between two vec3's. Returns {Number} squared distance between a and b Calculates the length of a vec3 Calculates the squared length of a vec3. Returns {Number} squared length of a SquaredLength() Negates the components of a vec3 Normalize a vec3 Calculates the dot product of two vec3's. Returns {Number} dot product of a and b Computes the cross product of two vec3's Performs a linear interpolation between two vec3's Transforms the vec3 with a mat4. 4th vector component is implicitly '1' Transforms the vec3 with a mat3. the vector to transform the 3x3 matrix to transform with Transforms the vec3 with a quat ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** Don't use this class unless you need it to interoperate with Mat4d Creates a new, empty vec3 Returns {vec3} a new 3D vector. Creates a new vec3 initialized with values from an existing vector. Returns {vec3} a new 3D vector Creates a new vec3 initialized with the given values. Returns {vec3} a new 3D vector Copy the values from one vec3 to another. Returns {vec3} out the receiving vector the source vector Set the components of a vec3 to the given values Adds two vec3's the receiving vector the first operand the second operand Subtracts vector b from vector a Multiplies two vec3's Alias of Mul() Divides two vec3's Returns the minimum of two vec3's Returns the maximum of two vec3's Scales a vec3 by a scalar number Adds two vec3's after scaling the second operand by a scalar value Calculates the euclidian distance between two vec3's. Returns {Number} distance between a and b Calculates the squared euclidian distance between two vec3's. Returns {Number} squared distance between a and b Calculates the length of a vec3 Calculates the squared length of a vec3. Returns {Number} squared length of a Negates the components of a vec3 Normalize a vec3 Calculates the dot product of two vec3's. Returns {Number} dot product of a and b Computes the cross product of two vec3's. Returns {vec3} out Performs a linear interpolation between two vec3's Transforms the vec3 with a mat4. 4th vector component is implicitly '1'. Returns {vec3} out Transforms the vec3 with a mat3. Returns {vec3} out Transforms the vec3 with a quat If given cuboidf collides with the terrain, returns the collision box it collides with. By default also checks if the cuboid is merely touching the terrain, set alsoCheckTouch to disable that. The distribution of the random numbers Select completely random numbers within avg-var until avg+var Select random numbers with numbers near avg being the most commonly selected ones, following a triangle curve Select random numbers with numbers near avg being the more commonly selected ones, following a gaussian curve Select random numbers with numbers near avg being the much more commonly selected ones, following a narrow gaussian curve Select random numbers with numbers near avg being the much much more commonly selected ones, following an even narrower gaussian curve Select random numbers with numbers near avg being the less commonly selected ones, following an upside down gaussian curve Select random numbers with numbers near avg being the much less commonly selected ones, following an upside down gaussian curve Select random numbers in the form of avg + var, with numbers near avg being preferred Select random numbers in the form of avg + var, with numbers near avg being strongly preferred Select random numbers in the form of avg + var, with numbers near avg being very strongly preferred Select completely random numbers within avg-var until avg+var only ONCE and then always 0 A more natural random number generator (nature usually doesn't grow by the exact same numbers nor does it completely randomly) "quantity": { "dist": "strongerinvexp", "avg": 6, "var": 4 } "quantity": { "avg": 4, "var": 2 } Always 0 Always 1 A full offset to apply to any values returned. The average value for the random float. The variation for the random float. The type of distribution to use that determines the commodity of values. Clamps supplied value to avg-var and avg+var Perlin noise of supplied amplitude and frequency. The resulting value is clamped to 0...1 Generates the octaves and frequencies using following formulas freq[i] = baseFrequency * 2^i amp[i] = persistence^i It's generally pretty hard to get a neatly normalized coherent noise function due to the way perlin/open simplex works (gauss curve) and how random numbers are generated. So instead of trying to find the perfect normalization factor and instead try to perform some approximate normalization this class allows a small overflow and brings it down very close to the [0, 1] range using tanh(). Returns values in a range of [0..1] Generates the octaves and frequencies using following formulas freq[i] = baseFrequency * 2^i amp[i] = persistence^i 2d noise 3d noise 3d Noise using custom amplitudes OpenSimplex noise of supplied amplitude and frequency. Generates the octaves and frequencies using following formulas freq[i] = baseFrequency * 2^i amp[i] = persistence^i OpenSimplex Noise in C# Ported from https://gist.github.com/KdotJPG/b1270127455a94ac5d19 by KdotJPG and heavily refactored to improve performance. Same as X Same as Y Same as X + Width Same as Y + Height If the given cuboid intersects with this cubiod If the given cuboid intersects with or is adjacent to this cubiod Returns if the given point is inside the cuboid Returns if the given point is inside the cuboid Returns an array of vectors for each point in a square, sorted by manhatten distance to center, exluding the center point Returns a square outline of given radius (only for odd lengths) Represents a vector of 2 doubles. Go bug Tyron of you need more utility methods in this class. Represents a vector of 2 doubles. Go bug Tyron of you need more utility methods in this class. Represents a vector of 2 doubles. Go bug Tyron of you need more utility methods in this class. Represents a vector of 3 floats. Go bug Tyron of you need more utility methods in this class. The X-dimension of this size. The Y-dimension for this size. The Z-dimension for this size. Represents a vector of 3 doubles. Go bug Tyron of you need more utility methods in this class. Represents a vector of 3 integers. Go bug Tyron of you need more utility methods in this class. Not really a sphere, actually now an AABB centred on x,y,z, but we keep the name for API consistency For performance, intended to compile equivalently to a byte[3], but more RAM efficient and more GC efficient Represents a vector of 2 ints. Go bug Tyron if you need more utility methods in this class. 27 lowest bits for X Coordinate, then 27 bits for Z coordinate Represents a vector of 3 doubles The X-Component of the vector The Y-Component of the vector The Z-Component of the vector Create a new vector with given coordinates Create a new vector with given coordinates Create a new vector with given coordinates Returns the n-th coordinate Returns the length of this vector Returns the dot product with given vector Returns the dot product with given vector Returns the dot product with given vector Returns the dot product with given vector Adds given x/y/z coordinates to the vector Adds given vector's x/y/z coordinates to the vector Adds given BlockPos's x/y/z coordinates to the vector Multiplies each coordinate with given multiplier Creates a copy of the vetor Turns the vector into a unit vector with length 1, but only if length is non-zero Calculates the distance the two endpoints Calculates the square distance the two endpoints Calculates the distance the two endpoints Adds given coordinates to a new vectors and returns it. The original calling vector remains unchanged Adds both vectors into a new vector. Both source vectors remain unchanged. Substracts val from each coordinate if the coordinate if positive, otherwise it is added. If 0, the value is unchanged. The value must be a positive number Creates a new vectors that is the normalized version of this vector. Creates a new double precision vector with the same coordinates Sets the vector to this coordinates Sets the vector to the coordinates of given vector Sets the vector to the coordinates of given vector Simple string represenation of the x/y/z components Represents a vector of 3 floats. Go bug Tyron of you need more utility methods in this class. The X-Component of the vector The Y-Component of the vector The Z-Component of the vector Synonum for X Synonum for Y Synonum for Z Create a new vector with given coordinates Create a new vector with given coordinates Create a new vector with given coordinates Returns the n-th coordinate Returns the length of this vector Returns the dot product with given vector Returns the dot product with given vector Returns the dot product with given vector Returns the dot product with given vector Adds given x/y/z coordinates to the vector Multiplies each coordinate with given multiplier Creates a copy of the vetor Turns the vector into a unit vector with length 1, but only if length is non-zero Calculates the distance the two endpoints Calculates the square distance the two endpoints Calculates the distance the two endpoints Adds given coordinates to a new vectors and returns it. The original calling vector remains unchanged Adds both vectors into a new vector. Both source vectors remain unchanged. Substracts val from each coordinate if the coordinate if positive, otherwise it is added. If 0, the value is unchanged. The value must be a positive number Creates a new vectors that is the normalized version of this vector. Creates a new double precision vector with the same coordinates Sets the vector to this coordinates Sets the vector to the coordinates of given vector Sets the vector to the coordinates of given vector Simple string represenation of the x/y/z components Represents a vector of 3 ints, similar to a Vec3i or a BlockPos but this is a struct The X-Component of the vector The Y-Component of the vector The Z-Component of the vector Synonum for X Synonum for Y Synonum for Z Create a new vector with given coordinates Create a new vector with given coordinates Create a new vector with given coordinates Returns the n-th coordinate Returns the length of this vector Adds given x/y/z coordinates to the vector Multiplies each coordinate with given multiplier Creates a copy of the vetor Calculates the distance the two endpoints Calculates the square distance the two endpoints Calculates the distance the two endpoints Adds both vectors into a new vector. Both source vectors remain unchanged. Creates a new double precision vector with the same coordinates Sets the vector to this coordinates Sets the vector to the coordinates of given vector Sets the vector to the coordinates of given vector Simple string represenation of the x/y/z components Represents a vector of 2 doubles. Go bug Tyron of you need more utility methods in this class. Center point in radians Allowed range from that center in radians Represents a vector of 2 floats. Go bug Tyron of you need more utility methods in this class. The X element of the vector. The Y element of the vector. Represents a vector of 2 ints. Go bug Tyron if you need more utility methods in this class. 27 lowest bits for X Coordinate, then 27 bits for Z coordinate Represents a vector of 3 doubles. Go bug Tyron of you need more utility methods in this class. Create a new instance with x/y/z set to 0 Create a new vector with given coordinates Returns the n-th coordinate Note: adjusts the calling Vec3d, does not make a copy Note: adjusts the calling Vec3d, does not make a copy Note: adjusts the calling Vec3d, does not make a copy Include dimension info. We don't always want this, but sometimes we do Represents a vector of 3 floats. Go bug Tyron of you need more utility methods in this class. Create a new instance with x/y/z set to 0 The X-Component of the vector The Y-Component of the vector The Z-Component of the vector Synonum for X Synonum for Y Synonum for Z Creates a new vector with x/y/z = 0 Create a new vector with given coordinates Create a new vector with given coordinates Create a new vector with given coordinates Returns the n-th coordinate Returns the length of this vector Returns the dot product with given vector Returns the dot product with given vector Returns the dot product with given vector Returns the dot product with given vector Creates the cross product from a and b and sets own values accordingly Creates the cross product from a and b and sets own values accordingly Adds given x/y/z coordinates to the vector Adds given x/y/z coordinates to the vector Adds given x/y/z coordinates to the vector Substracts given x/y/z coordinates to the vector Substracts given x/y/z coordinates to the vector Multiplies each coordinate with given multiplier Creates a copy of the vetor Turns the vector into a unit vector with length 1, but only if length is non-zero Calculates the square distance the two endpoints Calculates the distance the two endpoints Adds given coordinates to a new vectors and returns it. The original calling vector remains unchanged Adds both vectors into a new vector. Both source vectors remain unchanged. Substracts val from each coordinate if the coordinate if positive, otherwise it is added. If 0, the value is unchanged. The value must be a positive number Creates a new vectors that is the normalized version of this vector. Creates a new double precision vector with the same coordinates Sets the vector to this coordinates Sets the vector to the coordinates of given vector Sets the vector to the coordinates of given vector Simple string represenation of the x/y/z components Represents a vector of 3 ints. Go bug Tyron if you need more utility methods in this class. List of offset of all direct and indirect neighbours of coordinate 0/0/0 Returns the n-th coordinate Substracts val from each coordinate if the coordinate if positive, otherwise it is added. If 0, the value is unchanged. The value must be a positive number Returns the n-th coordinate Synonum for X Synonum for Y Synonum for Z Synonum for W Returns the n-th coordinate Turns the vector into a unit vector with length 1, but only if length is non-zero Returns the length of this vector Represents a vector of 4 ints. Go bug Tyron if you need more utility methods in this class. Returns the squared Euclidean horizontal distance to between this and given position Represents a vector of 4 shorts. Go bug Tyron if you need more utility methods in this class. Represents a vector of 4 unsigned shorts. Go bug Tyron if you need more utility methods in this class. Mods can create server threads to carry out an asynchronous process, by implementing this interface and calling IServerApi.AddServerThread() The core api implemented by the server. The main interface for accessing the server. Contains all sub components and some miscellaneous methods. API Component for registering to various Events API Component for access/modify everything game world related API Component for accessing server related functionality Everything related to roles and privileges Everything related to player groups World-agnostic player data. You can query this information even when the player is offline API for sending/receiving network packets API for accessing anything in the game world Shows a vibrating red text in the players screen. If text is null the client will try to find a language entry using supplied code prefixed with 'ingameerror-' (which is recommended so that the errors are translated to the users local language) If text is null, these are the arguments passed into the Language translation tool Shows a discovery text on the players screen. If text is null the client will try to find a language entry using supplied code prefixed with 'ingamediscovery-' (which is recommended so that the errors are translated to the users local language) If text is null, these are the arguments passed into the Language translation tool Sends a chat message only to given player in given groupId Custom data to a message to be received by the client Sends a chat message to all online players in given player group Custom data to a message to be received by the client Sends a chat message to all online players in all of their channels Custom data to a message to be received by the client Injects a message or command into the server console input processing system. This lets you run commands or chat as Admin. Calls a command as if given player called it Register a new item type Register a new Block. Must happen before server runphase LoadGame. These are sent to the client during connect, so only need to register them on the server side. BlockType to register. The Server assigns a block id and sets block.blockId Registers a new crafting recipe. These are sent to the client during connect, so only need to register them on the server side. Registers a new tree generator Registers a new tree generator Registers a chat command. When registered on the client you access the command by prefixing a dot (.), on the server it's a slash (/) Registers a chat command. When registered on the client you access the command by prefixing a dot (.), on the server it's a slash (/) For internal use: used to remap block and item Ids, as soon as assets are loaded from disk, before recipes etc. are loaded or anything else which may occur in modsystem AssetsLoaded() methods Returns a copy of the player data dictionary loaded by the server. Thats the contents of Playerdata/playerdata.json Retrieve a players offline, world-agnostic data by player uid Retrieve a players offline, world-agnostic data by his last known name Resolves a player name to a player uid, independent on whether this player is online, offline or never even joined the server. This is done by contacting the auth server, so please use this method sparingly. Resolves a player uid to a player name, independent on whether this player is online, offline or never even joined the server. This is done by contacting the auth server, so please use this method sparingly. Retrieve a role by its role code Set given role for given player. Role must exist in the serverconfig.json. For a list of roles, read sapi.Config.Roles Set given role for given player. Role must exist in the serverconfig.json. For a list of roles, read sapi.Config.Roles Registers a user privilege with the server. Is only active for the current server session and lost during a server restart/shutdown, so register it during server startup. New privileges are auto-granted to admins and the server console. Privilege to register Short description By default, super users are automatically granted all privileges. Set this value to false to change that Grants privilege to all players connected or yet to connect. This setting is only active for the current server session and lost during a server restart/shutdown. Revokes a privilege that has been previously granted to all players. Does not revoke privileges granted from a group. Does nothing if this privilege hasn't been previously granted. Grant a privilege to an individual connected player. Wether to store this privilege permanently. Otherwise only valid for the active server session. False if player was not found Actively denies a privilege from a player, overrides privileges granted by a role. Does not however override non permanent privileges False if player was not found Removes a previously set privilege denial, if any was set. Revokes a privilege that has been previously granted to this player. Does not revoke privileges granted from a group. Does nothing if the player does not have given privilege. If true it removes a previously granted permanent privilege. If false it removes a previously granted temporary privilege. False if player was not found Add given privilege to given group, granting everyone in this group access to this privilege. This setting is only active for the current server session and lost during a server restart/shutdown. Revokes given privilege to given group, revoking everyones access to this privilege inside this group Returns the players permission level API for general Server features The ip adress the server is listening at All players known to the server (which joined at least once while the server was running) The servers current configuration as configured in the serverconfig.json. You can set the values but you need to call MarkDirty() to have them saved Marks the config dirty for saving Returns the servers current run phase Returns whether the current server a dedicated server Determines if the server process has been asked to terminate. Use this when you need to save data in a method registered using RegisterOnSave() before server quits. true if server is about to shutdown Gracefully shuts down the server Allows mods to add a ServerThread. Useful for off-thread tasks which must be run continuously (at specified intervals) while the server is running. Calling code simply needs to implement IAsyncServerSystem Does a blocking wait until given thread is paused. Returns true if the thread was paused within given time Resumes a previously paused thread If true, code should generally aim to reduce the number of CPU threads used on the server, even at the cost of slight performance delays Returns the number of seconds the server has been running since last restart Server uptime in seconds Server uptime in milliseconds Returns the number of seconds the current world has been running. This is the playtime displayed on the singleplayer world list. Returns a logging interface to log any log level message Log given message with type = EnumLogType.Chat Log given message with type = EnumLogType.Build Log given message with type = EnumLogType.VerboseDebug Log given message with type = EnumLogType.Debug Log given message with type = EnumLogType.Notification Log given message with type = EnumLogType.Warning Log given message with type = EnumLogType.Error Log given message with type = EnumLogType.Fatal Add the specified dimension to the LoadedMiniDimensions, and return its allocated subdimension index.
A mini dimension is a small set of blocks up to 4096x4096x4096 used for schematic previews, vehicles etc Set the specified mini-dimension at the specified subdimension index, and return its index
A mini dimension is a small set of blocks up to 4096x4096x4096 used for schematic previews, vehicles etc Get the mini-dimension at the specified subdimension index; returns null if none exists
A mini dimension is a small set of blocks up to 4096x4096x4096 used for schematic previews, vehicles etc Remove an entity from the physics ticking system on the server. Add an entity to the physics ticking system on the server. Some extra methods available for server side chunks Allows setting of server side only moddata of this chunk Retrieve server side only mod data The game version where this chunk was created. Please note that this is not the version at which this chunk was complete. Chunks can linger around in a half complete state for a long time. If true, this chunk is not at the edge of the loaded or generating map: all eight neighbouring chunks are fully loaded Remove a block entity Amount of (survival) player placed blocks Amount of (survival) player removed blocks Contains methods to hook into various server processes Returns the list of currently registered map chunk generator handlers for given world type. Returns an array of handler lists. Each element in the array represents all the handlers for one worldgenpass (see EnumWorldGenPass) When world type is null, all handlers are returned "standard" for the vanilla world generator If you require neighbour chunk data during world generation, you have to register to this event to receive access to the chunk generator thread. This method is only called once during server startup. Triggered before the first chunk, map chunk or map region is generated, given that the passed on world type has been selected. Called right after the save game has been loaded. Event that is triggered whenever a new column of chunks is being generated. It is always called before the ChunkGenerator event For which world types to use this generator Event that is triggered whenever a new 16x16 section of column of chunks is being generated. It is always called before the ChunkGenerator and before the MapChunkGeneration event For which world types to use this generator Vintagestory uses this method to generate the basic terrain (base terrain + rock strata + caves) in full columns. Only called once in pass EnumWorldGenPass.TerrainNoise. Register to this event if you need acces to a whole chunk column during inital generation. For which world types to use this generator Registers a method to be called by certain special worldgen triggers, for example Resonance Archives entrance staircase Trigger the special worldgen hook, with the name "hook", if it exists Called when just loaded (or generated) a full chunkcolumn Called whenever the server loaded from disk or fully generated a chunkcolumn Called just before a chunk column is about to get unloaded. On shutdown this method is called for all loaded chunks, so this method can get called tens of thousands of times there, beware Registers a handler to be called every time a player uses a block. The methods return value determines if the player may place/break this block. Called when the server attempts to spawn given entity. Return false to deny spawning. Called when a player interacts with an entity Called when a new player joins Called when a player got respawned Called when a player joins Called when a player joins and his client is now fully loaded and ready to play Called when a player intentionally leaves Called whenever a player disconnects (timeout, leave, disconnect, kick, etc.). Called when a player wrote a chat message Called when a player died Whenever a player switched his game mode or has it switched for him Fired before a player changes their active slot (such as selected hotbar slot). Allows for the event to be cancelled depending on the return value. Fired after a player changes their active slot (such as selected hotbar slot). Triggered after assets have been loaded and parsed and registered, but before they are declared to be ready - e.g. you can add more behaviors here, or make other code-based changes to properties read from JSONs
Note: modsystems should register for this in a Start() method not StartServerSide(): the AssetsFinalizer event is fired before StartServerSide() is reached Triggered after the game world data has been loaded. At this point all blocks are loaded and the Map size is known.

In 1.17+ do NOT use this server event to add or update behaviors or attributes or other fixed properties of any block, item or entity, in code (additional to what is read from JSON). Instead, code which needs to do that should be registered for event sapi.Event.AssetsFinalizers. See VSSurvivalMod system BlockReinforcement.cs for an example. Triggered after a savegame has been created - i.e. when a new world was created Triggered when starting up worldgen during server startup (as the final stage of the WorldReady EnumServerRunPhase) Triggered when a new multithreaded physics thread starts (for example, use this to initialise any ThreadStatic element which must be initialised per-thread) Triggered before the game world data is being saved to disk Called when something wants to pause the server, e.g. the autosave system. This method will be called every 50ms until all delegates return Ready state. Timeout is 60 seconds. Called when something wants to resume execution of the server, e.g. the autosave system Triggered whenever the server enters a new run phase. Since mods are only loaded during run phase "LoadGamePre" registering to any earlier event will get triggered. Registers a method to be called every given interval Registers a method to be called every time a player places a block Registers a handler to be called every time a player places a block. The methods return value determines if the player may place/break this block. When returning false the client will be notified and the action reverted Called when a block should got broken now (that has been broken by a player). Set handling to PreventDefault to handle the block breaking yourself. Otherwise the engine will break the block (= either call heldItemstack.Collectible.OnBlockBrokenWith when player holds something in his hands or block.OnBlockBroken). Registers a method to be called every time a player deletes a block. Called after the block was already broken Registers a method to be called every time a player uses a block Triggers an immediate ClientAwarenessEvent for the specified player Registers a method to be called every time the server receives the gait from a client-authoritative mount entity API Features to set up a network channel for custom server<->client data exchange. Server side. Supplies you with your very own and personal network channel that you can use to send packets across the network. Use the same channelName on the client and server to have them link up. Unique channel identifier Returns a previously registered channeled, null otherwise Supplies you with your very own and personal network channel that you can use to send packets across the network. Use the same channelName on the client and server to have them link up. Do not send larger messages then 508 bytes since some clients may be behind NAT/firwalls that may drop your packets if they get fragmented Unique channel identifier Returns a previously registered channeled, null otherwise Sends a blockentity packet to the given player. For quick an easy network communication without setting up a channel first. Sends a entity packet to the given player and entity. For quick an easy entity network communication without setting up a channel first. Sends a entity packet to all players in range. For quick an easy entity network communication without setting up a channel first. Broadcasts a blockentity packet to all connected players. For quick an easy network communication without setting up a channel first. Sends a packet data to given players. This lets you mess with the raw network communication if you know the protocol. Use with caution! For normal network communication you probably want to register your own network channel. (for internal use: packet should be a Packet_Server) Sends a packet data to everyone except given players. This lets you mess with the raw network communication if you know the protocol. Use with caution! For normal network communication you probably want to register your own network channel. (for internal use: packet should be a Packet_Server) Sends a blockentity packet to the given player. For quick an easy network communication without setting up a channel first. Uses ProtoBuf.net to serialize the data. Broadcasts a blockentity packet to all connected players. For quick an easy network communication without setting up a channel first. Uses ProtoBuf.net to serialize the data. A message to be sent across the network. Is serialized/deserialized using protobuf Handler for processing a message Represent a custom network channel for sending messages between client and server Registers a handler for when you send a packet with given messageId. Must be registered in the same order as on the server. Registers a handler for when you send a packet with given messageId. Must be registered in the same order as on the server. Registers a handler for when you send a packet with given messageId Sends a packet to given player Sends a packet to given player, where the byte[] data has already been serialized When called on Sends a packet to all connected player, except given players Represents a player on the server side that joined the server at least once. May not be online at this point in time. The "radius" of chunks that the player already received. If set to 0, the server will recheck all nearby chunks if they have been sent or not and send them when necessary Retrieves the current connection state of the client Get the IP for the given player ID. Returns null if not connected, or when called on client side. The language this player is currently using Returns the players ping time in seconds. Returns NaN if not connected or when on client side. The players configuration that is world independent Notifies all clients of given players playerdata. Useful when you modified any of the WorldData. Does nothing if this player is not connected. Also sends the player data to the player himself Disconnects (kicks) this player from the server. Does nothing if this player is not connected. Disconnects (kicks) a player from the server with given reason. Does nothing if this player is not connected. Message displayed to the player Shows a vibrating red text in the players screen. If message is null the client will try to find a language entry using supplied code prefixed with 'ingameerror-' (which is recommended so that the errors are translated to the users local language) If message is null, these are the arguments passed into the Language translation tool Sends a chat message to this player to given groupId. You can use GlobalConstants.GeneralChatGroup as groupId to send it to the players general chat. Optional parameter that can be used to pass on unformated data. Just like stdin/stdout/stderr, you could see this as a separate "programming communication channel" Sends a chat message (notification type) to this player, localised to the player's own language independent from the server language
The message will be string formatted - similar to Lang.Get() - with the specified optional args Sets the players privilege role. For a list of roles, read sapi.Config.Roles Sets a player specific spawn position Removes the player specific spawn position, which means it will default to the role or global default spawn position Returns the default spawn position. This method will return the custom spawnpoint if one has been permanently set. If no custom spawnpoint is present this method will return the global default spawnpoint. Returns null when called on client side. If true, and this spawn point is use limited, will consume one use of it Allows setting of arbitrary, permanantly stored moddata attached to this player. Not synced to client. Removes the permanently stored mod data Retrieve arbitrary, permantly stored mod data The world accessor implemented by the server The internal cache of all currently loaded entities. Warning: You should not set or remove anything from this dic unless you *really* know what you're doing. Use SpawnEntity/DespawnEntity instead.

Intended to be used, for example, to search for an entity's presence, or to iterate through all loaded entities.

Please leave it to the game engine to add and remove entities from this dictionary. From 1.18.2 onwards, if you really need to add or remove anything directly to/from this dictionary in your own code - which is *strongly* not recommended - then you should cast this to (CachingConcurrentDictionary) first. Removes an entity from the game and the chunk it resides in Creates an explosion at given position. List of all loaded tree generators Dictionary of entity codes to remap, old codes (which may be present in save files or schematics) as keys Gets the WorldName from the save game If true, the chunk will never get unloaded unless UnloadChunkColumn() is called Callback for when the chunks are ready and loaded Additional config to pass onto the world generators Until which world gen pass to generate the chunk (default: Done) Callback for when the chunks are ready and loaded Additional config to pass onto the world generators Methods to modify the game world Returns a (cloned) list of all currently loaded map chunks. The key is the 2d index of the map chunk, can be turned into an x/z coord Returns a (cloned) list of all currently loaded map regions. The key is the 2d index of the map region, can be turned into an x/z coord Returns a (cloned) list of all currently loaded chunks. The key is the 3d index of the chunk, can be turned into an x/y/z coord. Warning: This locks the loaded chunk dictionary during the clone, preventing other threads from updating it. In other words: Using this method often will have a significant performance impact. Amount of chunk columns currently in the generating queue The worlds savegame object. If you change these values they will be permanently stored The currently selected playstyle All landclaims Allows setting a 32 float array that defines the brightness of each block light level. Has to be set before any players join or any chunks are generated. Allows setting a 32 float array that defines the brightness of each sun light level. Has to be set before any players join or any chunks are generated. Sets the default light range of sunlight. Default is 24. Has to be set before any players join or any chunks are generated. Sets the default sea level for the world to be generated. Currently used by the client to calculate the correct temperature/rainfall values for climate tinting. Gets the Server map region at given coordinate. Returns null if it's not loaded or does not exist yet Gets the Server map region at given coordinate. Returns null if it's not loaded or does not exist yet Gets the Server map chunk at given coordinate. Returns null if it's not loaded or does not exist yet Gets the Server map chunk at given coordinate index. Returns null if it's not loaded or does not exist yet Gets the Server chunk at given coordinate. Returns null if it's not loaded or does not exist yet Gets the Server chunk at given coordinate. Returns null if it's not loaded or does not exist yet Gets the Server chunk at given coordinate. Returns null if it's not loaded or does not exist yet Returns a number that is guaranteed to be unique for the current world every time it is called. Curently use for entity herding behavior. Completely disables automatic generation of chunks that normally builds up a radius of chunks around the player. Disables sending of normal chunks to all players except for force loaded ones using ForceLoadChunkColumn Asynchronly high priority load a chunk column at given coordinate. Additional loading options Asynchronly high priority load a chunk column at given coordinate. Additional loading options Asynchronly high priority load an area of chunk columns at given coordinates. Make sure that X1<=X2 and Z1<=Z2 Additional loading options Asynchronly high priority load an area of chunk columns at given coordinates. Make sure that X1<=X2 and Z1<=Z2 Additional loading options Asynchronly normal priority load a chunk column at given coordinate. No effect when already loaded. If true, the chunk will never get unloaded unless UnloadChunkColumn() is called Generates chunk at given coordinate, completely bypassing any existing world data and caching methods, in other words generates, a chunk from scratch without keeping it in the list of loaded chunks Asynchrounly checks if this chunk is currently loaded or in the savegame database. Calls the callback method with true or false once done looking up. Does not load the actual chunk data. Asynchrounly checks if this map chunk is currently loaded or in the savegame database. Calls the callback method with true or false once done looking up. Does not load the actual map chunk data. Asynchrounly checks if this mapregion is currently loaded or in the savegame database. Calls the callback method with true or false once done looking up. Does not load the actual map region data. Send or Resend a loaded chunk to all connected players. Has no effect when the chunk is not loaded If true, the chunk will not be sent to connected players that are out of range from that chunk Returns true if the server sent chunk at given coords to player and has it not unloaded yet Send or Resend a loaded chunk to a connected player. Has no effect when the chunk is not loaded If true, the chunk will not be sent to connected players that are out of range from that chunk Send or resent a loaded map chunk to all connected players. Has no effect when the map chunk is not loaded Unloads a column of chunks at given coordinate independent of any nearby players and sends an appropriate unload packet to the player Deletes a column of chunks at given coordinate from the save file. Also deletes the map chunk at the same coordinate (but keeps the map region). Also unloads the chunk in the same process. Also deletes all entities in this chunk Deletes a map region at given coordinate from the save file Width of the current world Height of the current world Length of the current world Finds the first y position that is solid ground to stand on. Returns null if the chunk is not loaded. Width/Length/Height in blocks of a region on the server Width/Length/Height in blocks of a chunk on the server Get the seed used to generate the current world The map seed The current world filename Retrieves the default spawnpoint (x/y/z coordinate) Default spawnpoint Permanently sets the default spawnpoint X coordinate of new spawnpoint Y coordinate of new spawnpoint Z coordinate of new spawnpoint Get the ID of a certain BlockType Name of the BlockType ID of the BlockType Floods the chunk column with sunlight. Only works on full chunk columns. Spreads the chunk columns light into neighbour chunks and vice versa. Only works on full chunk columns. Does a complete relighting of the cuboid deliminated by given min/max pos. Completely resends all affected chunk columns to all connected nearby clients. Does a complete relighting of the cuboid deliminated by given min/max pos. Can completely resend all affected chunk columns to all connected nearby clients. Retrieve a customized interface to access blocks in the loaded game world. Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after a call to SetBlock and the light values changed by that Log an error message if GetBlock/SetBlock was called to an unloaded chunk If strict, crashes the server if a unloaded chunk was crashed, prints an exception and exports a png image of the current loaded chunks Retrieve a customized interface to access blocks in the loaded game world. Does not to relight/sync on a SetBlock until Commit() is called. On commit all touched blocks are relit/synced at once. This method should be used when setting many blocks (e.g. tree generation, explosion, etc.). Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after the a call to SetBlock and the light values changed by that Same as GetBlockAccessorBulkUpdate, additionally, each Commit() stores the previous state and you can perform undo/redo operations on these. Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after a call to SetBlock and the light values changed by that Same as GetBlockAccessor but you have to call PrefetchBlocks() before using GetBlock(). It pre-loads all blocks in given area resulting in faster GetBlock() access Whether or not a call to Setblock should send the update also to all connected clients Whether or not to relight the chunk after a call to SetBlock and the light values changed by that Same as the normal block accessor but remembers the previous chunk that was accessed. This can give you a 10-50% performance boosts when you scan many blocks in tight loops DONT FORGET: Call .Begin() before getting/setting in a tight loop. Not calling it can cause the game to crash Creates columns of empty chunks in the specified dimension Loads chunk columns for the specified dimension API access to force send a chunk column in any dimension Test if the given map region exists, can only be called before EnumServerRunPhase.RunGame. Used in InitWorldgen to check chunks before the games is running Test if the given map chunk exists, can only be called before EnumServerRunPhase.RunGame. Used in InitWorldgen to check chunks before the games is running Load the given map chunk , can only be called before EnumServerRunPhase.RunGame. This only loads and deserializes the chunk data, you need to call .Dispose() after you do not need them anymore Used in InitWorldgen to check chunks before the games is running How strongly the Server should protect against hacking No verification or protection of any kind Server will: Simulate each players movements and correct the position if the client reports the player at a different positions, verify the players picking range when placing or removing blocks Not used yet The current connection state of a player thats currently connecting to the server These are the stages the server goes through during launch Server is listening to sockets but nothing has been launched yet Before anything has been initialized (you cannot receive any events at this point) Server only stuff initialized, Serversystems instantatied, now initializing ServerSystems then Mods. Serversystem receive events at this point. Everything initialized, now loading config Mods will be compiled and started, AssetManager will init all origins and cache assets. Mods are initialized at this point (PreStart/Start method) Final touches for loaded assets. Mods receive AssetsFinalize() call All configs loaded, game world loaded by server. Mods receive StartClient/ServerSide and events at this point. All configs loaded, game world loaded by server. All blocks are loaded. All configs loaded, spawn chunks loaded, game world loaded by server. All blocks are loaded. Notifies mods that the world is ready, after all other loading steps. Following this, worldgen will start and spawn chunks loaded (no separate RunPhase in 1.19) About to run first game world tick. Shutdown has begun Shutdown complete True if this is a newly created world The game version under which this savegame was created The game version under which this savegame was last saved A globally unique identifier for this savegame Gets a previously saved object from the savegame. Returns null if no such data under this key was previously set. The key to look for Store the given data persistently to the savegame. Size limit is around 1 gigabyte for *all* data stored along with the savegame datastructure. If you need more space, you have to store it somewhere else. Key value Data to save Gets a previously saved object from the savegame. Returns null if no such data under this key was previously set. Store the given data persistently to the savegame. Size limit is around 1 gigabyte for *all* data stored along with the savegame datastructure. If you need more space, you have to store it somewhere else. Singleplayer OpenToLan: All players can join, Dedicated server: Only whitelisted players can join All players can join Only whitelisted players can join The servers configuration The current network port Name of the server, currently not used Displays when the user logs in. Max amount of concurrent players, any beyond will be denied to join If the cli argument --maxclients is set then the value provided by the cli arg will be returned instead of the one from the config Password the player has to supply to join How many chunks in each direction should be loaded at most for each player (1 chunk = 32 blocks) Of often the server should tick in milliesconds Horizontal distance in chunks from each player to tick blocks randomly The maximum number of blocks to tick per server tick The number of blocks to sample for ticks each pass within a single chunk The interval of time in ms between each execution of the random tick system List of player roles Default player role AntiAbuse protection level. Use not recommended, it is very buggy at the moment If true, only whitelisted players can join Default spawn position for players Whether or not to allow Player versus Player Whether or not fire should spread Whether or not falling blocks should fall (e.g. sand and gravel) and floating single rock blocks should break Used to disable certain features in HostedMode (wgen commands, ...) Used to enable/disable the /moddb commands in HostedMode only Whether or not to log breaking and placing of blocks to the server-build.log After how many line we should split the log file into a new one (server-build.log -> server-build-2.log) The player configuration that is world independent The players unique identifier The players role code Privilige explicitly granted to this player Privilige explicitly revoked from this player List of groups the player is a member off Whether or not this player wants to receive group invites The players last known player name. This may have changed since the last log in. Store your own custom data in here if you need. Might want to serialize your data to json code first. Extra land claim allowance (beyond whats granted by the role) Extra land claim areas (beyond whats granted by the role) Place or break blocks Interact with block (e.g. door, chest) Place or break blocks everywhere, completely ignoring area permissons. You still need to be in creative mode however. Use blocks everywhere, completely ignoring area permissons. You still need to be in creative mode however. Cause damage to a player Cause damage to any non-player creature Ability to fly or change movepseed Ability to set own game mode Ability to set own picking range Ability to chat Ability to use the /kill command Ability to kick players Ability to ban/unban a player Ability to whitelist/unwhitelist a player Ability to set welcome message Ability to make a server wide announcement Ability to see client, group, banned user and area lists Ability to create block from given block id Ability to claim lands Ability to set default spawn Ability to restart/shutdown server, reload mods, etc. Ability to teleport Ability to read, modify game world time Ability to set player role and ability to grant/revoke individual privileges. A player can only grant the same or a lower level group and the same or less privileges. Ability to do everything and have all permissions Ability to issue a command for another player (e.g. teleport another player or set another players game mode) Ability to join/leave/invite/op own player groups and their chat channels Ability to create/disband own player groups and their chat channels The stages a chunk goes through when being created Nothing generated yet Does not require neighbour chunks to exist. Should generates 3d rock terrain mostly. Default generators by execute order: 0 = Basic 3D Terrain (granite+rock) 0.1 = Rock Strata 0.3 = Cave generator 0.4 = Block layers (soil, gravel, sand, ice, tall grass, etc.) Requires neighbour chunks. Ravines, Lakes, Boulders. Default generators by execute order: 0.1 = Hot springs 0.2 = Deposits (Ores, Peat, Clay, etc.) 0.3 = Worldgen Structures 0.4 = Above sealevel Lakes 0.5 = Worldgen Structures Post Pass Requires neighbour chunks. Default generators by execute order: 0.2 = Story structures. Creates exclusion zones for the other vegetation passes 0.5 = Block Patches, Shrubs and Trees 0.9 = Rivulets (single block water sources) 0.95 = Sunlight flooding only inside current chunk Requires neighbour chunks. Does the lighting of the chunk. 0 = Snow layer 0.95 = Sunlight flooding into neighbouring chunks Requires neighbour chunks. Nothing left to generate, but neighbour chunks might still generate stuff into this chunk 0.1 = Generate creatures Chunk generation complete. This pass is not triggered as an event. Retrieve a customized interface to access blocks for generating chunks Whether or not SetBlock should update the heightmap Like GetChunk() but includes a cache of the last chunk fetched - use this in a loop where getting the chunk for neighbouring blockPos, so most will be in the same chunk This always unpacks the chunk, unless it is null. Implementing code must ensure the chunk is unpacked before returning it, unless returning the cached chunk and notRecentlyAccessed is false (i.e. if the cache chunk was recently accessed then it's safe to assume it was already unpacked) Index for a chunk coordinate - NOT DIMENSION AWARE Returns a special IWorldAccessor which wraps the standard one with one difference: it returns this IWorldGenBlockAccessor as its BlockAccessor, in place of the general BlockAccessor for this world Tells the server to produce a block update at this given position once the chunk is fully generated and world ticking has begun Tells the server to relight this position once RunScheduledBlockLightUpdates() is called currently unused but might be used in the future to make sure old light is removed properly This will run all scheduled block light updates at once. Should be called after all lighting has been completed. Adds given initialized entity to the world. Requires you to set the Pos and ServerPos fields. List of registered map region generation handlers List of registered map chunk generation handlers List of registered map chunk generation handlers per pass (see EnumWorldGenPass) Empties all three lists Creates a cube mesh with edge points 0/0/0 and 1/1/1 Creates a cube mesh with edge points -1/-1/-1 and 1/1/1 Use like any IDictionary. Similar to a FastSmallDictionary, but this one is thread-safe for simultaneous reads and writes - will not throw a ConcurrentModificationException
This also inherently behaves as an OrderedDictionary (though without the OrderedDictionary extension methods such as ValuesOrdered, those can be added in future if required)
Low-lock: there is no lock or interlocked operation except when adding new keys or when removing entries
Low-memory: and contains only a single null field, if it is empty
Two simultaneous writes, with the same key, at the same time, on different threads: small chance of throwing an intentional ConcurrentModificationException if both have the same keys, otherwise it's virtually impossible for us to preserve the rule that the Dictionary holds exactly one entry per key Amount of entries currently in the Dictionary Threadsafe: but this might occasionally enumerate over a value which has, meanwhile, been removed from the Dictionary by a different thread Iterate over .Keys or .Values instead if an instantaneous snapshot is required (which will also therefore be a historical snapshot, if another thread meanwhile makes changes) Wipes the contents and resets the count. A single object to allow the arrays in ConcurrentSmallDictionary to be replaced atomically. Keys, once entered in the keys array within a DTable, are invariable: if we ever need to remove a key we will create a new DTable Special constructor for a new array with a single, first, entry Special constructor which copies the old arrays and adds one new entry at the end - all will be atomic when the Dictionary replaces contents with the results of this Special constructor which copies the old arrays and removes one entry the index of the entry to remove Returns true if key exists (in which case the value at that key is replaced), otherwise returns false true if successful replacement, otherwise false Add the key value pair to the table. Fails (adds nothing and returns false) if the table is full Implementation of Semantic Verisoning standard, version 2.0.0. See https://semver.org/ for specifications. Converts the specified string representation of a semantic version to its equivalent. Thrown if the specified string is null. Thrown if the specified string doesn't contain a proper properly formatted semantic version. Tries to convert the specified string representation of a semantic version to its equivalent, returning true if successful. When this method returns, contains a valid, non-null SemVer, If the conversion failed, this is set to the parser's best guess. Thrown if the specified string is null. Tries to convert the specified string representation of a semantic version to its equivalent, returning true if successful. When this method returns, contains a valid, non-null SemVer, If the conversion failed, this is set to the method's best guess. When this method returns, contains the first error describing why the conversion failed, or null if it succeeded. Thrown if the specified string is null. Returns whether the specified string contains only valid identifier characters. That is, only alphanumeric characters and hyphens, [0-9A-Za-z-]. Does not check for empty identifiers. Returns whether the specified string is a numeric identifier (only contains digits). Splits a string into dot-separated identifiers. Both null and empty strings return an empty array.