Helper class for bundling non-bundleable items More...

Inheritance diagram for essentials.action.ItemFramework.ItemBundle:

Public Member Functions
	ItemBundle ()

	ItemBundle (IItem item, int quantity)

	ItemBundle (IItem item)

IItem	RemoveOne ()
	Remove a representation of a single item in the bundle More...

void	AddOne ()
	Add one item to a given bundle More...

bool	Is< T > ()

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.ItemBase
	ItemBase ()

override string	ToString ()

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

Protected Member Functions
override System.Drawing.Bitmap	LoadIcon ()
	Loads the bitmap representing the image of the item More...

override IReadonlyModel	LoadModel ()
	Loads the mesh representing the model in-world More...

Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableObject
	SyncableObject ()
	Initializes a new instance of the pluginbase.Objects.Syncable.SyncableObject class. More...

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< SyncableObject >
void	Touch ()
	Touch the instance, notifying something has changed More...

virtual void	OnChanged ()
	Raises the changed event. More...

abstract void	Persist (IPersistObject obj)
	Persist the instance to a persist object More...

abstract void	Load (IReadPersistObject obj)
	Load the instance from a persist object More...

Properties
int	Quantity `[get, set]`

IItem	Item `[get]`

override string	Name `[get]`

override string	IconLabel `[get]`

override string	Icon `[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 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 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...

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.ItemBase
readonly IModelFactory	ModelFactory

readonly IPluginLogger	Logger

virtual float	ModelSize => 0.5f
	Size to render the model More...

virtual Matrix4	ModelTransform => null
	How to transform the generated model (Only impacts generated meshes, not loaded models) More...

virtual ItemRenderMode	ItemRenderMode => ItemRenderMode.Meshalizer
	How the item is rendered when dropped (ItemDropEntity) More...

Events inherited from pluginbase.Objects.Syncable.SyncableBase< SyncableObject >
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

Helper class for bundling non-bundleable items

Constructor & Destructor Documentation

◆ ItemBundle() [1/3]

essentials.action.ItemFramework.ItemBundle.ItemBundle ( )

37 {

38 }

◆ ItemBundle() [2/3]

essentials.action.ItemFramework.ItemBundle.ItemBundle	(	IItem	item,
		int	quantity
	)

         {
             this._itemSync.Value = item;
             this._quantitySync.Value = quantity;
         }

◆ ItemBundle() [3/3]

essentials.action.ItemFramework.ItemBundle.ItemBundle ( IItem item )

47 :this(item, 1)

48 { }

Member Function Documentation

◆ AddOne()

void essentials.action.ItemFramework.ItemBundle.AddOne ( )

Add one item to a given bundle

Implements essentials.action.ItemFramework.IItemQuantityBundleable.

         {
             this.Quantity++;
         }

◆ Is< T >()

bool essentials.action.ItemFramework.ItemBundle.Is< T > ( )

         {
             return typeof(T) == this._itemSync.Type;
         }

◆ LoadIcon()

override System.Drawing.Bitmap essentials.action.ItemFramework.ItemBundle.LoadIcon ( )

protectedvirtual

Loads the bitmap representing the image of the item

Returns: The icon.

Reimplemented from essentials.action.ItemFramework.ItemBase.

         {
             if (this.Item != null)
             {
                 return this.Item.LoadIcon();
             }
             return base.LoadIcon();
         }

◆ LoadModel()

override IReadonlyModel essentials.action.ItemFramework.ItemBundle.LoadModel ( )

protectedvirtual

Loads the mesh representing the model in-world

Returns: The model.

Reimplemented from essentials.action.ItemFramework.ItemBase.

         {
             if (this.Item != null)
             {
                 return this.Item.LoadModel();
             }
             return base.LoadModel();
         }

◆ RemoveOne()

IItem essentials.action.ItemFramework.ItemBundle.RemoveOne ( )

Remove a representation of a single item in the bundle

Returns: The one.

Implements essentials.action.ItemFramework.IItemQuantityBundleable.

         {
             if (this.Quantity > 0)
             {
                 this.Quantity--;
                 return (IItem)Activator.CreateInstance(this._itemSync.Type);
             }
             return null;
         }

◆ Split()

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

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

Parameters

count Count.

Implements essentials.action.ItemFramework.IItemQuantity.

         {
             int splitCount = Math.Min(count, this.Quantity);
             this.Quantity -= splitCount;
             return new ItemBundle(this.Item, splitCount);
         }

◆ StacksWith()

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

Gets whether or not this stack can stack with another item

Returns: true, if with was stacksed, false otherwise.

Parameters

item Item.

Implements essentials.action.ItemFramework.IItemQuantity.

         {
             var bundle = item as ItemBundle;
             return bundle != null && bundle._itemSync.Type == this._itemSync.Type;
         }

Property Documentation

◆ Icon

override string essentials.action.ItemFramework.ItemBundle.Icon

getprotected

◆ IconLabel

override string essentials.action.ItemFramework.ItemBundle.IconLabel

get

◆ Item

IItem essentials.action.ItemFramework.ItemBundle.Item

get

◆ Name

override string essentials.action.ItemFramework.ItemBundle.Name

get

◆ Quantity

int essentials.action.ItemFramework.ItemBundle.Quantity

getset

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

essentials.action/ItemFramework/ItemBundle.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members