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

A base return object for an item-use action More...

Static Public Member Functions

static ItemUseReturn Consumed ()
 Helper method that sets ItemConsumed=true More...
 
static ItemUseReturn None ()
 Helper method that returns default ItemUseReturn values More...
 

Public Attributes

bool ItemConsumed = false
 Whether or not the item has been consumed as part of a use-event More...
 

Detailed Description

A base return object for an item-use action

Member Function Documentation

static ItemUseReturn essentials.action.ItemFramework.Interactive.ItemUseReturn.Consumed ( )
static

Helper method that sets ItemConsumed=true

19  {
20  return new ItemUseReturn{
21  ItemConsumed = true
22  };
23  }
bool ItemConsumed
Whether or not the item has been consumed as part of a use-event
Definition: ItemUseReturn.cs:13
static ItemUseReturn essentials.action.ItemFramework.Interactive.ItemUseReturn.None ( )
static

Helper method that returns default ItemUseReturn values

29  {
30  return new ItemUseReturn();
31  }

Member Data Documentation

bool essentials.action.ItemFramework.Interactive.ItemUseReturn.ItemConsumed = false

Whether or not the item has been consumed as part of a use-event


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