Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
essentials.action.ItemFramework.IItemQuantity Interface Reference

Denotes an item that has quantity, and is able to stack with other items More...

Inheritance diagram for essentials.action.ItemFramework.IItemQuantity:
essentials.action.ItemFramework.IItem pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetWatcher essentials.action.ItemFramework.IItemQuantityBundleable essentials.action.ItemFramework.BlockStackItem essentials.action.ItemFramework.ItemBundle essentials.action.ItemFramework.Interactive.UseableBlockItem

Public Member Functions

bool StacksWith (IItem item)
 Gets whether or not this stack can stack with another item More...
 
IItemQuantity Split (int count)
 Splits the stack into another stack of a count, removing the items from this stack More...
 
- Public Member Functions inherited from essentials.action.ItemFramework.IItem
IReadonlyModel LoadModel ()
 Loads the mesh representing the model in-world More...
 
Bitmap LoadIcon ()
 Loads the bitmap representing the image of the item More...
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.INetSyncable
void ResetWatch ()
 Resets the watch. Overridable to reset all sub-items More...
 
void EncodeTo (BinaryWriter writer, EncodeContext context)
 Encodes to. More...
 
void DecodeFrom (BinaryReader reader, DecodeContext context)
 Decodes from. More...
 
void Persist (IPersistObject obj)
 Persist the network object to a persist object More...
 
void Load (IReadPersistObject obj)
 Load the network object from a persist object More...
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.INetWatcher
void Touch ()
 Touch the class, signalling that a change ocurred More...
 
void TouchRecurse ()
 Touches a class and any sub-classes it may have More...
 

Properties

int Quantity [get, set]
 Gets or sets the quantity of the stack More...
 
- Properties inherited from essentials.action.ItemFramework.IItem
string Name [get]
 The human-readable name of the item More...
 
string IconLabel [get]
 Gets the wording that can appear over a icon More...
 
bool ShowNameplate [get]
 Whether or not to show the nameplate above the item More...
 
bool Bounce [get]
 Whether or not the item should bounce in the world More...
 
bool AutoDespawn [get]
 Whether or not the item should be subject to auto-despawn More...
 
TimeSpan AutoDespawnDelay [get]
 The amount of time the auto despawn will take, if set (Overrides global default) More...
 
bool HasGravity [get]
 Whether or not gravity affects the item More...
 
double ViewDistance [get]
 The distance from which the dropped item can be viewed More...
 
- Properties inherited from pluginbase.Objects.Syncable.INetSyncable
INetWatcher Watcher [get, set]
 Who is watching (who to inform of a change) More...
 
bool Modified [get]
 Gets a value indicating whether this pluginbase.Objects.Syncable.INetSyncable is modified. More...
 

Detailed Description

Denotes an item that has quantity, and is able to stack with other items

Member Function Documentation

IItemQuantity essentials.action.ItemFramework.IItemQuantity.Split ( int  count)

Splits the stack into another stack of a count, removing the items from this stack

Parameters
countCount.

Implemented in essentials.action.ItemFramework.BlockStackItem, and essentials.action.ItemFramework.ItemBundle.

bool essentials.action.ItemFramework.IItemQuantity.StacksWith ( IItem  item)

Gets whether or not this stack can stack with another item

Returns
true, if with was stacksed, false otherwise.
Parameters
itemItem.

Implemented in essentials.action.ItemFramework.BlockStackItem, and essentials.action.ItemFramework.ItemBundle.

Property Documentation

int essentials.action.ItemFramework.IItemQuantity.Quantity
getset

Gets or sets the quantity of the stack

The quantity.


The documentation for this interface was generated from the following file: