flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

APIDump: Next batch of cWorld documentation.

Browse Source
This commit is contained in:
madmaxoft 2013-09-15 22:30:17 +02:00
parent a6b3c560a2
commit 7ecd728f1e
1 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
MCServer/Plugins/APIDump/APIDesc.lua
View File

@ -1387,41 +1387,40 @@ Sign entities are saved and loaded from disk when the chunk they reside in is sa
GetBlockMeta = { Params = "BlockX, BlockY, BlockZ", Return = "number", Notes = "Returns the block metadata of the block at the specified coords, or 0 if the appropriate chunk is not loaded." },
GetBlockSkyLight = { Params = "BlockX, BlockY, BlockZ", Return = "number", Notes = "Returns the block skylight of the block at the specified coords, or 0 if the appropriate chunk is not loaded." },
GetBlockTypeMeta = { Params = "BlockX, BlockY, BlockZ", Return = "BlockValid, BlockType, BlockMeta", Notes = "Returns the block type and metadata for the block at the specified coords. The first value specifies if the block is in a valid loaded chunk, the other values are valid only if BlockValid is true." },
GetClassStatic = { Params = "", Return = "", Notes = "" },
GetDimension = { Params = "", Return = "", Notes = "" },
GetGameMode = { Params = "", Return = "", Notes = "" },
GetGeneratorQueueLength = { Params = "", Return = "", Notes = "" },
GetHeight = { Params = "", Return = "", Notes = "" },
GetIniFileName = { Params = "", Return = "", Notes = "" },
GetLightingQueueLength = { Params = "", Return = "", Notes = "" },
GetMaxCactusHeight = { Params = "", Return = "", Notes = "" },
GetMaxSugarcaneHeight = { Params = "", Return = "", Notes = "" },
GetName = { Params = "", Return = "", Notes = "" },
GetNumChunks = { Params = "", Return = "", Notes = "" },
GetSignLines = { Params = "", Return = "", Notes = "" },
GetSpawnX = { Params = "", Return = "", Notes = "" },
GetSpawnY = { Params = "", Return = "", Notes = "" },
GetSpawnZ = { Params = "", Return = "", Notes = "" },
GetStorageLoadQueueLength = { Params = "", Return = "", Notes = "" },
GetStorageSaveQueueLength = { Params = "", Return = "", Notes = "" },
GetTicksUntilWeatherChange = { Params = "", Return = "", Notes = "" },
GetTime = { Params = "", Return = "", Notes = "" },
GetTimeOfDay = { Params = "", Return = "", Notes = "" },
GetWeather = { Params = "", Return = "", Notes = "" },
GetWorldAge = { Params = "", Return = "", Notes = "" },
GrowCactus = { Params = "", Return = "", Notes = "" },
GrowMelonPumpkin = { Params = "", Return = "", Notes = "" },
GrowRipePlant = { Params = "", Return = "", Notes = "" },
GrowSugarcane = { Params = "", Return = "", Notes = "" },
GrowTree = { Params = "", Return = "", Notes = "" },
GrowTreeByBiome = { Params = "", Return = "", Notes = "" },
GrowTreeFromSapling = { Params = "", Return = "", Notes = "" },
IsBlockDirectlyWatered = { Params = "", Return = "", Notes = "" },
IsDeepSnowEnabled = { Params = "", Return = "", Notes = "" },
IsGameModeAdventure = { Params = "", Return = "", Notes = "" },
IsGameModeCreative = { Params = "", Return = "", Notes = "" },
IsGameModeSurvival = { Params = "", Return = "", Notes = "" },
IsPVPEnabled = { Params = "", Return = "", Notes = "" },
GetClassStatic = { Params = "", Return = "string", Notes = "Returns the name of the class, \"cWorld\"." },
GetDimension = { Params = "", Return = "eDimension", Notes = "Returns the dimension of the world - dimOverworld, dimNether or dimEnd." },
GetGameMode = { Params = "", Return = "eGameMode", Notes = "Returns the gamemode of the world - gmSurvival, gmCreative or gmAdventure." },
GetGeneratorQueueLength = { Params = "", Return = "number", Notes = "Returns the number of chunks that are queued in the chunk generator." },
GetHeight = { Params = "BlockX, BlockZ", Return = "number", Notes = "Returns the maximum height of the particula block column in the world. If the chunk is not loaded, it waits for it to load / generate. <b>WARNING</b>: Do not use, Use TryGetHeight() instead for a non-waiting version, otherwise you run the risk of a deadlock!" },
GetIniFileName = { Params = "", Return = "string", Notes = "Returns the name of the world.ini file that the world uses to store the information." },
GetLightingQueueLength = { Params = "", Return = "number", Notes = "Returns the number of chunks in the lighting thread's queue." },
GetMaxCactusHeight = { Params = "", Return = "number", Notes = "Returns the configured maximum height to which cacti will grow naturally." },
GetMaxSugarcaneHeight = { Params = "", Return = "number", Notes = "Returns the configured maximum height to which sugarcane will grow naturally." },
GetName = { Params = "", Return = "string", Notes = "Returns the name of the world, as specified in the settings.ini file." },
GetNumChunks = { Params = "", Return = "number", Notes = "Returns the number of chunks currently loaded." },
GetSignLines = { Params = "BlockX, BlockY, BlockZ", Return = "IsValid, [Line1, Line2, Line3, Line4]", Notes = "Returns true and the lines of a sign at the specified coords, or false if there is no sign at the coords." },
GetSpawnX = { Params = "", Return = "number", Notes = "Returns the X coord of the default spawn" },
GetSpawnY = { Params = "", Return = "number", Notes = "Returns the Y coord of the default spawn" },
GetSpawnZ = { Params = "", Return = "number", Notes = "Returns the Z coord of the default spawn" },
GetStorageLoadQueueLength = { Params = "", Return = "number", Notes = "Returns the number of chunks queued up for loading" },
GetStorageSaveQueueLength = { Params = "", Return = "number", Notes = "Returns the number of chunks queued up for saving" },
GetTicksUntilWeatherChange = { Params = "", Return = "number", Notes = "Returns the number of ticks that will pass before the weather is changed" },
GetTimeOfDay = { Params = "", Return = "number", Notes = "Returns the number of ticks that have passed from the sunrise, 0 .. 24000." },
GetWeather = { Params = "", Return = "eWeather", Notes = "Returns the current weather in the world (wSunny, wRain, wStorm)." },
GetWorldAge = { Params = "", Return = "number", Notes = "Returns the total age of the world, in ticks. The age always grows, cannot be set by plugins and is unrelated to TimeOfDay." },
GrowCactus = { Params = "BlockX, BlockY, BlockZ, NumBlocksToGrow", Return = "", Notes = "Grows a cactus block at the specified coords, by up to the specified number of blocks. Adheres to the world's maximum cactus growth (GetMaxCactusHeight())." },
GrowMelonPumpkin = { Params = "BlockX, BlockY, BlockZ, StemType", Return = "", Notes = "Grows a melon or pumpkin, based on the stem type specified (assumed to be in the coords provided). Checks for normal melon / pumpkin growth conditions - stem not having another produce next to it and suitable ground below." },
GrowRipePlant = { Params = "BlockX, BlockY, BlockZ, IsByBonemeal", Return = "bool", Notes = "Grows the plant at the specified coords. If IsByBonemeal is true, checks first if the specified plant type is bonemealable in the settings. Returns true if the plant was grown, false if not." },
GrowSugarcane = { Params = "BlockX, BlockY, BlockZ, NumBlocksToGrow", Return = "", Notes = "Grows a sugarcane block at the specified coords, by up to the specified number of blocks. Adheres to the world's maximum sugarcane growth (GetMaxSugarcaneHeight())." },
GrowTree = { Params = "BlockX, BlockY, BlockZ", Return = "", Notes = "Grows a tree based at the specified coords. If there is a sapling there, grows the tree based on that sapling, otherwise chooses a tree image based on the biome." },
GrowTreeByBiome = { Params = "BlockX, BlockY, BlockZ", Return = "", Notes = "Grows a tree based at the specified coords. The tree type is picked from types available for the biome at those coords." },
GrowTreeFromSapling = { Params = "BlockX, BlockY, BlockZ, SaplingMeta", Return = "", Notes = "Grows a tree based at the specified coords. The tree type is determined from the sapling meta (the sapling itself needn't be present)." },
IsBlockDirectlyWatered = { Params = "BlockX, BlockY, BlockZ", Return = "bool", Notes = "Returns true if the specified block has a water block right next to it (on the X/Z axes)" },
IsDeepSnowEnabled = { Params = "", Return = "bool", Notes = "Returns whether the configuration has DeepSnow enabled." },
IsGameModeAdventure = { Params = "", Return = "bool", Notes = "Returns true if the current gamemode is gmAdventure." },
IsGameModeCreative = { Params = "", Return = "bool", Notes = "Returns true if the current gamemode is gmCreative." },
IsGameModeSurvival = { Params = "", Return = "bool", Notes = "Returns true if the current gamemode is gmSurvival." },
IsPVPEnabled = { Params = "", Return = "bool", Notes = "Returns whether PVP is enabled in the world settings." },
QueueBlockForTick = { Params = "", Return = "", Notes = "" },
QueueSaveAllChunks = { Params = "", Return = "", Notes = "" },
QueueSetBlock = { Params = "", Return = "", Notes = "" },