Improve documentation, fix file encoding (#1026)

This commit is contained in:
ORelio 2020-05-26 11:20:12 +02:00
parent 87b2d3bf4a
commit efb49fd05d
5 changed files with 3037 additions and 3022 deletions

View file

@ -660,15 +660,6 @@ namespace MinecraftClient
return Handler.GetEntityHandlingEnabled();
}
public bool GetInventoryEnabled()
{
return Handler.GetInventoryEnabled();
}
public Dictionary<int, Container> GetInventories()
{
return Handler.GetInventories();
}
/// <summary>
/// start Sneaking
/// </summary>
@ -900,10 +891,10 @@ namespace MinecraftClient
}
/// <summary>
/// Plays animation
/// Plays animation (Player arm swing)
/// </summary>
/// <param name="animation"> <0|1></param>
/// <returns>TRUE animation done</returns>
/// <param name="animation">0 for left arm, 1 for right arm</param>
/// <returns>TRUE if animation successfully done</returns>
protected bool SendAnimation(int animation)
{
return Handler.DoAnimation(animation);
@ -919,7 +910,16 @@ namespace MinecraftClient
}
/// <summary>
/// Get a copy of the player's inventory
/// Check inventory handling enable status
/// </summary>
/// <returns></returns>
public bool GetInventoryEnabled()
{
return Handler.GetInventoryEnabled();
}
/// <summary>
/// Get the player's inventory. Do not write to it, will not have any effect server-side.
/// </summary>
/// <returns>Player inventory</returns>
protected Container GetPlayerInventory()
@ -929,15 +929,28 @@ namespace MinecraftClient
}
/// <summary>
/// Change player selected hotbar
/// Get all inventories, player and container(s). Do not write to them. Will not have any effect server-side.
/// </summary>
/// <param name="slot"></param>
/// <returns>All inventories</returns>
public Dictionary<int, Container> GetInventories()
{
return Handler.GetInventories();
}
/// <summary>
/// Change player selected hotbar slot
/// </summary>
/// <param name="slot">0-8</param>
/// <returns>True if success</returns>
protected bool ChangeSlot(short slot)
{
return Handler.ChangeSlot(slot);
}
/// <summary>
/// Get current player selected hotbar slot
/// </summary>
/// <returns>0-8</returns>
protected byte GetCurrentSlot()
{
return Handler.GetCurrentSlot();