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

A client-side interface that has methods when an item is equiped for use More...

Inheritance diagram for essentials.action.ItemFramework.Interactive.IEquipableItem:
essentials.action.ItemFramework.IItem pluginbase.Objects.Syncable.INetSyncable pluginbase.Objects.Syncable.INetWatcher essentials.action.ItemFramework.Interactive.Bases.UseableItemBase essentials.action.ItemFramework.Interactive.UseableBlockItem essentials.action.ItemFramework.Interactive.Bases.DeterioratingItemBase essentials.action.ItemFramework.Interactive.Bases.Simple.MagicWand essentials.action.ItemFramework.Interactive.Bases.WorldModifyingItemBase essentials.action.ItemFramework.Interactive.Bases.Simple.Shovel

Public Member Functions

void Equip ()
 Called when an item is equipped More...
 
void Unequip ()
 Called when an item is unequipped More...
 
void UpdateDisplay (Vector3d position, Vector3d direction)
 While the item is equipped, this will be called regularly to update the position and direction the using player is facing 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...
 

Additional Inherited Members

- 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

A client-side interface that has methods when an item is equiped for use

Member Function Documentation

void essentials.action.ItemFramework.Interactive.IEquipableItem.Equip ( )

Called when an item is equipped

Implemented in essentials.action.ItemFramework.Interactive.Bases.UseableItemBase.

void essentials.action.ItemFramework.Interactive.IEquipableItem.Unequip ( )

Called when an item is unequipped

Implemented in essentials.action.ItemFramework.Interactive.Bases.UseableItemBase.

void essentials.action.ItemFramework.Interactive.IEquipableItem.UpdateDisplay ( Vector3d  position,
Vector3d  direction 
)

While the item is equipped, this will be called regularly to update the position and direction the using player is facing

Parameters
positionPosition.
directionDirection.

Implemented in essentials.action.ItemFramework.Interactive.Bases.UseableItemBase.


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