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

APIDump: Documented cEnchantments.

Browse Source 
The constants are self-documenting, no need to describe them further.
This commit is contained in:
madmaxoft 2013-10-24 16:32:51 +02:00
parent 785301c9a0
commit 7c2ba55442
1 changed files with 37 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -693,10 +693,20 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(),
cEnchantments = cEnchantments =
{ {
Desc = [[This class is the storage for enchantments for a single {{cItem|cItem}} object, through its m_Enchantments member variable. Although it is possible to create a standalone object of this class, it is not yet used in any API directly. Desc = [[
</p> This class is the storage for enchantments for a single {{cItem|cItem}} object, through its
<p>Enchantments can be initialized either programmatically by calling the individual functions (SetLevel()), or by using a string description of the enchantment combination. This string description is in the form "id=lvl;id=lvl;...;id=lvl;", where id is either a numerical ID of the enchantment, or its textual representation from the table below, and lvl is the desired enchantment level. The class can also create its string description from its current contents; however that string description will only have the numerical IDs. m_Enchantments member variable. Although it is possible to create a standalone object of this class,
]], it is not yet used in any API directly.</p>
<p>
Enchantments can be initialized either programmatically by calling the individual functions
(SetLevel()), or by using a string description of the enchantment combination. This string
description is in the form "id=lvl;id=lvl;...;id=lvl;", where id is either a numerical ID of the
enchantment, or its textual representation from the table below, and lvl is the desired enchantment
level. The class can also create its string description from its current contents; however that
string description will only have the numerical IDs.</p>
<p>
See the {{cItem}} class for usage examples.
]],
Functions = Functions =
{ {
constructor = constructor =
@ -715,6 +725,29 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(),
}, },
Constants = Constants =
{ {
-- Only list these enchantment IDs, as they don't really need any kind of documentation:
enchAquaAffinity = { Notes = "" },
enchBaneOfArthropods = { Notes = "" },
enchBlastProtection = { Notes = "" },
enchEfficiency = { Notes = "" },
enchFeatherFalling = { Notes = "" },
enchFireAspect = { Notes = "" },
enchFireProtection = { Notes = "" },
enchFlame = { Notes = "" },
enchFortune = { Notes = "" },
enchInfinity = { Notes = "" },
enchKnockback = { Notes = "" },
enchLooting = { Notes = "" },
enchPower = { Notes = "" },
enchProjectileProtection = { Notes = "" },
enchProtection = { Notes = "" },
enchPunch = { Notes = "" },
enchRespiration = { Notes = "" },
enchSharpness = { Notes = "" },
enchSilkTouch = { Notes = "" },
enchSmite = { Notes = "" },
enchThorns = { Notes = "" },
enchUnbreaking = { Notes = "" },
}, },
}, },