Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
essentials.action.ItemFramework.Interactive.UseableBlockItem Class Reference

A BlackStackItem class that implements IUseable for use from an inventory More...

Inheritance diagram for essentials.action.ItemFramework.Interactive.UseableBlockItem:
essentials.action.ItemFramework.BlockStackItem essentials.action.ItemFramework.Interactive.IEquipableItem essentials.action.ItemFramework.Interactive.IUseableItem essentials.action.ItemFramework.BlockItem essentials.action.ItemFramework.IItemQuantityBundleable essentials.action.ItemFramework.IItem essentials.action.ItemFramework.IItem essentials.action.ItemFramework.ItemBase essentials.action.ItemFramework.IItemQuantity pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.SyncableObject essentials.action.ItemFramework.IItem essentials.action.ItemFramework.IItem pluginbase.Objects.Syncable.INetWatcher pluginbase.Objects.Syncable.INetWatcher pluginbase.Objects.Syncable.SyncableBase< T > pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetWatcher pluginbase.Objects.Syncable.INetWatcher pluginbase.Objects.Syncable.INetWatcher

Public Member Functions

 UseableBlockItem ()
 
 UseableBlockItem (ushort blockId, int quantity=1)
 
 UseableBlockItem (IBlock block, int quantity=1)
 
- Public Member Functions inherited from essentials.action.ItemFramework.BlockStackItem
 BlockStackItem ()
 
 BlockStackItem (IBlock block, int quantity)
 
 BlockStackItem (ushort block, int quantity)
 
IItem RemoveOne ()
 Remove a representation of a single item in the bundle More...
 
void AddOne ()
 Add one item to a given bundle More...
 
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.BlockItem
 BlockItem ()
 
 BlockItem (ushort blockId)
 
 BlockItem (IBlock block)
 
- Public Member Functions inherited from essentials.action.ItemFramework.ItemBase
 ItemBase ()
 
override string ToString ()
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.SyncableObject
 SyncableObject ()
 Initializes a new instance of the pluginbase.Objects.Syncable.SyncableObject class. More...
 

Static Public Member Functions

static UseableBlockItem FromBlockItem (BlockItem block)
 
static UseableBlockItem FromBlockItem (BlockStackItem block)
 

Protected Member Functions

virtual bool BlockSelectPredicate (IWorldReadonlyBlock block)
 
- Protected Member Functions inherited from essentials.action.ItemFramework.BlockStackItem
override IReadonlyModel LoadModel ()
 Loads the mesh representing the model in-world More...
 
- Protected Member Functions inherited from essentials.action.ItemFramework.BlockItem
override Bitmap LoadIcon ()
 Loads the bitmap representing the image of the item More...
 
- Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableObject
sealed override void ResetWatch ()
 Reset variables watched status More...
 
sealed override void TouchRecurse ()
 Touch self, including all children of this syncable object More...
 
sealed override void EncodeTo (BinaryWriter writer, EncodeContext context)
 Encode changes to binary data More...
 
sealed override void DecodeFrom (BinaryReader reader, DecodeContext context)
 Decode changes from binary data More...
 
sealed override void Persist (IPersistObject obj)
 Build up a persistant object for this syncable, including all sync children and persist objects More...
 
sealed override void Load (IReadPersistObject obj)
 Load a given persistent object back into this instance More...
 
- Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableBase< T >
void Touch ()
 Touch the instance, notifying something has changed More...
 
virtual void OnChanged ()
 Raises the changed event. More...
 

Properties

virtual int Reach [get]
 
override string Name [get]
 
- Properties inherited from essentials.action.ItemFramework.BlockStackItem
int Quantity [get, set]
 
override string IconLabel [get]
 
override string ModelCacheKey [get]
 
virtual int MaxQuantityDisplay [get]
 
virtual int QuantityDisplayRatio [get]
 
- Properties inherited from essentials.action.ItemFramework.BlockItem
ushort BlockId [get]
 
IBlock Block [get]
 
override string Name [get]
 
override string Icon [get]
 
override ItemRenderMode ItemRenderMode [get]
 
- Properties inherited from essentials.action.ItemFramework.ItemBase
abstract string Icon [get]
 Gets the path to the icon More...
 
abstract string Name [get]
 Gets the name of the item More...
 
virtual string IconLabel [get]
 
virtual string Description [get]
 
virtual string MeshResource [get]
 
virtual string ModelImage [get]
 
virtual int MeshalizerResolution [get]
 
virtual float MeshalizerDepth [get]
 
virtual float ModelSize [get]
 
virtual ItemRenderMode ItemRenderMode [get]
 
virtual string ModelCacheKey [get]
 
virtual bool ShowNameplate [get]
 
virtual bool Bounce [get]
 
virtual bool AutoDespawn [get]
 
virtual TimeSpan AutoDespawnDelay [get]
 
virtual bool HasGravity [get]
 
virtual double ViewDistance [get]
 
- Properties inherited from pluginbase.Objects.Syncable.SyncableObject
virtual ushort NetOwnerId [get]
 Gets the network owner of this object (user id) 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...
 
- 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 essentials.action.ItemFramework.IItemQuantity
int Quantity [get, set]
 Gets or sets the quantity of the stack More...
 

Additional Inherited Members

- Protected Attributes inherited from essentials.action.ItemFramework.BlockItem
IBlockLookup BlockManager
 
IResourceResolver ResourceResolver
 
- Protected Attributes inherited from essentials.action.ItemFramework.ItemBase
readonly IModelFactory ModelFactory
 
readonly IPluginLogger Logger
 
- Events inherited from pluginbase.Objects.Syncable.SyncableBase< T >
Action< T > Changed
 Event triggered when any change occurs on this object, either locally or over the network More...
 
Action< T > NetUpdate
 Event triggered when a change occurs resulting from a change over the network More...
 
Action< T > Touched
 Event occurs only when an object is first touched. Usually the first instance of a local-change More...
 

Detailed Description

A BlackStackItem class that implements IUseable for use from an inventory

Constructor & Destructor Documentation

essentials.action.ItemFramework.Interactive.UseableBlockItem.UseableBlockItem ( )
24  {
25  this.InjectDependencies();
26  }
essentials.action.ItemFramework.Interactive.UseableBlockItem.UseableBlockItem ( ushort  blockId,
int  quantity = 1 
)
29  :base(blockId, quantity)
30  {
31  this.InjectDependencies();
32  }
essentials.action.ItemFramework.Interactive.UseableBlockItem.UseableBlockItem ( IBlock  block,
int  quantity = 1 
)
35  :this(block.Id, quantity)
36  { }
ushort Id
Id that represent the block type (usually hash of InternalName)
Definition: IBlock.cs:32

Member Function Documentation

virtual bool essentials.action.ItemFramework.Interactive.UseableBlockItem.BlockSelectPredicate ( IWorldReadonlyBlock  block)
protectedvirtual
109  {
110  return block.Block.Solid;
111  }
IBlock Block
Block that exists here
Definition: IWorldReadonlyBlock.cs:19
bool Solid
Is the block solid, that is, does it have collision
Definition: IBlock.cs:188
static UseableBlockItem essentials.action.ItemFramework.Interactive.UseableBlockItem.FromBlockItem ( BlockItem  block)
static
39  {
40  return new UseableBlockItem(block.BlockId);
41  }
UseableBlockItem()
Definition: UseableBlockItem.cs:23
static UseableBlockItem essentials.action.ItemFramework.Interactive.UseableBlockItem.FromBlockItem ( BlockStackItem  block)
static
44  {
45  return new UseableBlockItem(block.BlockId, block.Quantity);
46  }
UseableBlockItem()
Definition: UseableBlockItem.cs:23

Property Documentation

override string essentials.action.ItemFramework.Interactive.UseableBlockItem.Name
get
virtual int essentials.action.ItemFramework.Interactive.UseableBlockItem.Reach
getprotected

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