Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
essentials.action.ItemFramework.IItem Interface Reference
Inheritance diagram for essentials.action.ItemFramework.IItem:
pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetWatcher essentials.action.ItemFramework.IItemQuantity essentials.action.ItemFramework.Interactive.IEquipableItem essentials.action.ItemFramework.Interactive.IUseableItem essentials.action.ItemFramework.ItemBase essentials.action.ItemFramework.IItemQuantityBundleable essentials.action.ItemFramework.Interactive.Bases.UseableItemBase essentials.action.ItemFramework.Interactive.UseableBlockItem essentials.action.ItemFramework.Interactive.Bases.UseableItemBase essentials.action.ItemFramework.Interactive.UseableBlockItem essentials.action.ItemFramework.BlockItem essentials.action.ItemFramework.Interactive.Bases.UseableItemBase essentials.action.ItemFramework.ItemBundle

Public Member Functions

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

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...
 

Member Function Documentation

Bitmap essentials.action.ItemFramework.IItem.LoadIcon ( )

Loads the bitmap representing the image of the item

Returns
The icon.

Implemented in essentials.action.ItemFramework.ItemBundle, essentials.action.ItemFramework.ItemBase, and essentials.action.ItemFramework.BlockItem.

IReadonlyModel essentials.action.ItemFramework.IItem.LoadModel ( )

Loads the mesh representing the model in-world

Returns
The model.

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

Property Documentation

bool essentials.action.ItemFramework.IItem.AutoDespawn
get

Whether or not the item should be subject to auto-despawn

true if auto despawn; otherwise, false.

TimeSpan essentials.action.ItemFramework.IItem.AutoDespawnDelay
get

The amount of time the auto despawn will take, if set (Overrides global default)

The auto despawn delay.

bool essentials.action.ItemFramework.IItem.Bounce
get

Whether or not the item should bounce in the world

true if bounce; otherwise, false.

bool essentials.action.ItemFramework.IItem.HasGravity
get

Whether or not gravity affects the item

true if this instance has gravity; otherwise, false.

string essentials.action.ItemFramework.IItem.IconLabel
get

Gets the wording that can appear over a icon

The icon label.

string essentials.action.ItemFramework.IItem.Name
get

The human-readable name of the item

The name.

bool essentials.action.ItemFramework.IItem.ShowNameplate
get

Whether or not to show the nameplate above the item

true if show nameplate; otherwise, false.

double essentials.action.ItemFramework.IItem.ViewDistance
get

The distance from which the dropped item can be viewed

The view distance.


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