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

Updated APIDoc (#3985)

This commit is contained in:
Lukas Pioch 2017-09-07 10:33:46 +02:00 committed by Mattes D
parent 104f9e127b
commit ed7adef1ca
5 changed files with 37 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
Server/Plugins/APIDump/APIDesc.lua
View File

@ -3856,10 +3856,6 @@ local Hash = cCryptoHash.sha1HexString("DataToHash")
},
Notes = "This entity has killed another entity (the Victim). For players, adds the scoreboard statistics about the kill.",
},
KilledBy =
{
Notes = "FIXME: Remove this from API",
},
MoveToWorld =
{
{
@ -3987,10 +3983,6 @@ local Hash = cCryptoHash.sha1HexString("DataToHash")
},
Notes = "Sets the entity's health to the specified amount of hitpoints. Doesn't broadcast any hurt animation. Doesn't kill the entity if health drops below zero. Use the TakeDamage() function instead for taking damage.",
},
SetHeight =
{
Notes = "FIXME: Remove this from API",
},
SetInvulnerableTicks =
{
Params =
@ -4189,10 +4181,6 @@ local Hash = cCryptoHash.sha1HexString("DataToHash")
},
Notes = "Sets the Z component of the entity speed",
},
SetWidth =
{
Notes = "FIXME: Remove this from API",
},
SetYaw =
{
Params =
@ -6472,7 +6460,13 @@ These ItemGrids are available in the API and can be manipulated by the plugins,
},
RemoveOneEquippedItem =
{
Notes = "Removes one item from the hotbar's currently selected slot",
Returns =
{
{
Type = "boolean",
},
},
Notes = "Removes one item from the hotbar's currently selected slot. Returns true on success.",
},
SendEquippedSlot =
{
@ -9344,7 +9338,7 @@ a_Player:OpenWindow(Window);
{
{
Name = "EffectType",
Type = "cEntityEffect",
Type = "cEntityEffect#eType",
},
{
Name = "EffectDurationTicks",
@ -9365,22 +9359,13 @@ a_Player:OpenWindow(Window);
{
Notes = "Removes all currently applied entity effects",
},
GetHealth =
{
Returns =
{
{
Type = "number",
},
},
},
HasEntityEffect =
{
Params =
{
{
Name = "EffectType",
Type = "cEntityEffect",
Type = "cEntityEffect#eType",
},
},
Returns =
@ -9390,14 +9375,6 @@ a_Player:OpenWindow(Window);
},
},
Notes = "Returns true, if the supplied entity effect type is currently applied",
},
Heal =
{
},
KilledBy =
{
},
RemoveEntityEffect =
{
@ -9405,23 +9382,11 @@ a_Player:OpenWindow(Window);
{
{
Name = "EffectType",
Type = "cEntityEffect",
Type = "cEntityEffect#eType",
},
},
Notes = "Removes a currently applied entity effect",
},
TakeDamage =
{
},
TeleportTo =
{
},
TeleportToEntity =
{
},
},
Inherits = "cEntity",
},
@ -9869,6 +9834,12 @@ a_Player:OpenWindow(Window);
Type = "number",
},
},
Returns =
{
{
Type = "number",
},
},
Notes = "Adds or removes XP from the current XP amount. Won't allow XP to go negative. Returns the new experience, -1 on error (XP overflow).",
},
Feed =
@ -9892,17 +9863,6 @@ a_Player:OpenWindow(Window);
},
Notes = "Tries to add the specified amounts to food level and food saturation level (only positive amounts expected). Returns true if player was hungry and the food was consumed, false if too satiated.",
},
FoodPoison =
{
Params =
{
{
Name = "NumTicks",
Type = "number",
},
},
Notes = "Starts the food poisoning for the specified amount of ticks; if already foodpoisoned, sets FoodPoisonedTicksRemaining to the larger of the two",
},
ForceSetSpeed =
{
Params =
@ -10077,10 +10037,6 @@ a_Player:OpenWindow(Window);
},
Notes = "Returns the food level (number of half-drumsticks on-screen)",
},
GetFoodPoisonedTicksRemaining =
{
Notes = "Returns the number of ticks left for the food posoning effect",
},
GetFoodSaturationLevel =
{
Returns =
@ -10093,6 +10049,12 @@ a_Player:OpenWindow(Window);
},
GetFoodTickTimer =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the number of ticks past the last food-based heal or damage action; when this timer reaches 80, a new heal / damage is applied.",
},
GetGameMode =
@ -10493,17 +10455,6 @@ a_Player:OpenWindow(Window);
{
Notes = "Reloads the player's rank, message visuals and permissions from the {{cRankManager}}, based on the player's current rank.",
},
MoveTo =
{
Params =
{
{
Name = "NewPosition",
Type = "Vector3d",
},
},
Notes = "Tries to move the player into the specified position.",
},
OpenWindow =
{
Params =
@ -10779,6 +10730,12 @@ a_Player:OpenWindow(Window);
Type = "number",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Sets the current amount of experience (and indirectly, the XP level).",
},
SetCustomName =
@ -10847,17 +10804,6 @@ a_Player:OpenWindow(Window);
},
Notes = "Sets the food level (number of half-drumsticks on-screen)",
},
SetFoodPoisonedTicksRemaining =
{
Params =
{
{
Name = "FoodPoisonedTicksRemaining",
Type = "number",
},
},
Notes = "Sets the number of ticks remaining for food poisoning. Doesn't send foodpoisoning effect to the client, use FoodPoison() for that.",
},
SetFoodSaturationLevel =
{
Params =

23
Server/Plugins/APIDump/Classes/Projectiles.lua
View File

@ -340,22 +340,12 @@ return
]],
Functions =
{
GetEntityEffect =
{
Returns =
{
{
Type = "cEntityEffect",
},
},
Notes = "Returns the entity effect in this potion",
},
GetEntityEffectType =
{
Returns =
{
{
Type = "cEntityEffect",
Type = "cEntityEffect#eType",
},
},
Notes = "Returns the effect type of this potion",
@ -380,17 +370,6 @@ return
},
Notes = "Returns the color index of the particles emitted by this potion",
},
SetEntityEffect =
{
Params =
{
{
Name = "EntityEffect",
Type = "cEntityEffect",
},
},
Notes = "Sets the entity effect for this potion",
},
SetEntityEffectType =
{
Params =

2
src/ClientHandle.h
View File

@ -242,7 +242,7 @@ public: // tolua_export
/** Returns the view distance that the player request, not the used view distance. */
int GetRequestedViewDistance(void) const { return m_RequestedViewDistance; }
void SetLocale(AString & a_Locale) { m_Locale = a_Locale; }
void SetLocale(const AString & a_Locale) { m_Locale = a_Locale; }
AString GetLocale(void) const { return m_Locale; }
int GetUniqueID(void) const { return m_UniqueID; }

7
src/Entities/Entity.h
View File

@ -217,7 +217,6 @@ public:
int GetChunkZ(void) const { return FloorC(m_Position.z / cChunkDef::Width); }
void SetHeadYaw (double a_HeadYaw);
void SetHeight (double a_Height);
void SetMass (double a_Mass);
void SetPosX (double a_PosX) { SetPosition({a_PosX, m_Position.y, m_Position.z}); }
void SetPosY (double a_PosY) { SetPosition({m_Position.x, a_PosY, m_Position.z}); }
@ -243,8 +242,6 @@ public:
/** Sets the speed in the Z axis, leaving the other speed components intact. Measured in m / sec. */
void SetSpeedZ(double a_SpeedZ);
void SetWidth (double a_Width);
void AddPosX (double a_AddPosX) { AddPosition(a_AddPosX, 0, 0); }
void AddPosY (double a_AddPosY) { AddPosition(0, a_AddPosY, 0); }
void AddPosZ (double a_AddPosZ) { AddPosition(0, 0, a_AddPosZ); }
@ -300,6 +297,10 @@ public:
// tolua_end
void SetHeight(double a_Height);
void SetWidth(double a_Width);
/** Exported in ManualBindings */
const Vector3d & GetPosition(void) const { return m_Position; }

5
src/Entities/SplashPotionEntity.h
View File

@ -41,16 +41,17 @@ public:
// tolua_begin
cEntityEffect::eType GetEntityEffectType(void) const { return m_EntityEffectType; }
cEntityEffect GetEntityEffect(void) const { return m_EntityEffect; }
int GetPotionColor(void) const { return m_PotionColor; }
const cItem & GetItem(void) const { return m_Item; }
void SetEntityEffectType(cEntityEffect::eType a_EntityEffectType) { m_EntityEffectType = a_EntityEffectType; }
void SetEntityEffect(cEntityEffect a_EntityEffect) { m_EntityEffect = a_EntityEffect; }
void SetPotionColor(int a_PotionColor) { m_PotionColor = a_PotionColor; }
// tolua_end
cEntityEffect GetEntityEffect(void) const { return m_EntityEffect; }
void SetEntityEffect(cEntityEffect a_EntityEffect) { m_EntityEffect = a_EntityEffect; }
protected:
cEntityEffect::eType m_EntityEffectType;