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

Updated documentation.

Browse Source
This commit is contained in:
Howaner 2014-07-31 12:15:18 +02:00
parent 556fc908ae
commit c49d4fd215
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
MCServer/Plugins/APIDump/Classes/BlockEntities.lua
View File

@ -63,16 +63,16 @@ return
{
IsActive = { Params = "", Return = "bool", Notes = "Is the beacon active?" },
GetBeaconLevel = { Params = "", Return = "number", Notes = "Returns the beacon level. (0 - 4)" },
GetPrimaryPotion = { Params = "", Return = "EffectType", Notes = "Returns the primary potion." },
GetSecondaryPotion = { Params = "", Return = "EffectType", Notes = "Returns the secondary potion." },
SelectPrimaryPotion = { Params = "EffectType", Return = "bool", Notes = "Select the primary potion. Returns false when the potion is invalid." },
SelectSecondaryPotion = { Params = "EffectType", Return = "bool", Notes = "Select the secondary potion. Returns false when the potion is invalid." },
GetPrimaryEffect = { Params = "", Return = "EffectType", Notes = "Returns the primary potion." },
GetSecondaryEffect = { Params = "", Return = "EffectType", Notes = "Returns the secondary potion." },
SelectPrimaryEffect = { Params = "EffectType", Return = "bool", Notes = "Select the primary effect. Returns false when the effect is invalid." },
SelectSecondaryEffect = { Params = "EffectType", Return = "bool", Notes = "Select the secondary effect. Returns false when the effect is invalid." },
CalculatePyramidLevel = { Params = "", Return = "number", Notes = "Calculate the amount of layers the pyramid below the beacon has." },
IsBeaconBlocked = { Params = "", Return = "bool", Notes = "Is the beacon blocked by non-transparent blocks that are higher than the beacon?" },
UpdateBeacon = { Params = "", Return = "", Notes = "Update the beacon." },
GiveEffects = { Params = "", Return = "", Notes = "Give the near-players the effects." },
IsMineralBlock = { Params = "BLOCKTYPE", Return = "bool", Notes = "Returns true if the block is a diamond block, a golden block, an iron block or an emerald block." },
IsValidPotion = { Params = "EffectType", Return = "bool", Notes = "Returns true if the potion can be used." },
IsValidEffect = { Params = "EffectType", Return = "bool", Notes = "Returns true if the effect can be used." },
},
},

6
src/BlockEntities/BeaconEntity.h
View File

@ -55,10 +55,10 @@ public:
cEntityEffect::eType GetPrimaryEffect(void) const { return m_PrimaryEffect; }
cEntityEffect::eType GetSecondaryEffect(void) const { return m_SecondaryEffect; }
/** Select the primary potion. Returns false when the potion is invalid.*/
/** Select the primary effect. Returns false when the effect is invalid.*/
bool SelectPrimaryEffect(cEntityEffect::eType a_Effect);
/** Select the secondary potion. Returns false when the potion is invalid. */
/** Select the secondary effect. Returns false when the effect is invalid. */
bool SelectSecondaryEffect(cEntityEffect::eType a_Effect);
/** Calculate the amount of layers the pyramid below the beacon has. */
@ -76,7 +76,7 @@ public:
/** Returns true if the block is a diamond block, a golden block, an iron block or an emerald block. */
static bool IsMineralBlock(BLOCKTYPE a_BlockType);
/** Returns true if the potion can be used. */
/** Returns true if the effect can be used. */
static bool IsValidEffect(cEntityEffect::eType a_Effect, char a_BeaconLevel);
// tolua_end