#include <002d.h>
Inheritance diagram for cLuaWindow:
Public Member Functions | |
| cLuaWindow (cWindow::WindowType a_WindowType, int a_SlotsX, int a_SlotsY, const AString &a_Title) | |
| Create a window of the specified type, with a slot grid of a_SlotsX * a_SlotsY size. | |
| cItemGrid & | GetContents (void) |
| Returns the internal representation of the contents that are manipulated by Lua. | |
| virtual | ~cLuaWindow () |
 Public Member Functions inherited from cWindow | |
| const cItem * | GetSlot (cPlayer &a_Player, int a_SlotNum) const |
| Returns the item at the specified slot for the specified player. Returns NULL if invalid SlotNum requested. | |
| char | GetWindowID (void) const |
| const AString & | GetWindowTitle () const |
| int | GetWindowType (void) const |
| bool | IsSlotInPlayerHotbar (int a_SlotNum) const |
| Returns true if the specified slot is in the Player Hotbar slotarea. | |
| bool | IsSlotInPlayerInventory (int a_SlotNum) const |
| Returns true if the specified slot is in the Player Main Inventory or Hotbar slotareas. Note that returns false for Armor. | |
| bool | IsSlotInPlayerMainInventory (int a_SlotNum) const |
| Returns true if the specified slot is in the Player Main Inventory slotarea. | |
| void | SetSlot (cPlayer &a_Player, int a_SlotNum, const cItem &a_Item) |
| Sets the item to the specified slot for the specified player. | |
| void | SetWindowTitle (const AString &a_WindowTitle) |
Additional Inherited Members | |
| Public Types inherited from cWindow | |
| enum | WindowType { Inventory = -1, Chest = 0, Workbench = 1, Furnace = 2, DropSpenser = 3, Enchantment = 4, Brewery = 5, NPCTrade = 6, Beacon = 7, Anvil = 8, Hopper = 9 } |
Detailed Description
A window that has been created by a Lua plugin and is handled entirely by that plugin
This object needs extra care with its lifetime management:
- It is created by Lua, so Lua expects to garbage-collect it later
- normal cWindow objects are deleted in their ClosedByPlayer() function if the last player closes them To overcome this, this object overloads the Destroy functions, which doesn't let the ClosedByPlayer() delete the window, but rather leaves it dangling, with only Lua having the reference to it. Additionally, to forbid Lua from deleting this object while it is used by players, the manual bindings for cPlayer:OpenWindow check if the window is of this class, and if so, make a global Lua reference for this object. This reference needs to be unreferenced in the Destroy() function.
Constructor & Destructor Documentation
| cLuaWindow::cLuaWindow | ( | cWindow::WindowType | a_WindowType, |
| int | a_SlotsX, | ||
| int | a_SlotsY, | ||
| const AString & | a_Title | ||
| ) |
Create a window of the specified type, with a slot grid of a_SlotsX * a_SlotsY size.
|
virtual |
Member Function Documentation
|
inline |
Returns the internal representation of the contents that are manipulated by Lua.
