Class ConsumingItemEventArgs
Contains all information before a player's consumable item effects are applied.
public class ConsumingItemEventArgs : IDeniableEvent, IConsumableEvent, IItemEvent, IPlayerEvent, IExiledEvent
- Inheritance
-
ConsumingItemEventArgs
- Implements
- Inherited Members
- Extension Methods
Constructors
ConsumingItemEventArgs(ReferenceHub, Consumable)
Initializes a new instance of the ConsumingItemEventArgs class.
public ConsumingItemEventArgs(ReferenceHub hub, Consumable item)
Parameters
hubReferenceHubThe player who is consuming the item.
itemConsumableThe consumable item to be consumed.
Properties
Consumable
Gets the consumable item to be consumed.
public Consumable Consumable { get; }
Property Value
IsAllowed
Gets or sets a value indicating whether the item's being consumed should be allowed or not.
public bool IsAllowed { get; set; }
Property Value
Item
Gets the Item triggering the event.
public Item Item { get; }
Property Value
Player
Gets the player who is consuming the item.
public Player Player { get; }