Class Item
Represents in-game items.
Namespace: Mannequin.Bindings
Assembly: Collapse.dll
Syntax
public class Item : objectConstructors
Item(EItemType, String)
Get an item by its asset name and type
Declaration
public Item(EItemType type, string name)Parameters
| Type | Name | Description |
|---|---|---|
| EItemType | type | The type of item this is |
| System.String | name | The asset name |
Properties
AvailableOnStartMenu
Whether this item is selectable from the starty menu or not
Declaration
public bool AvailableOnStartMenu { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
CanDrop
Whether this item can be dropped or not
Declaration
public bool CanDrop { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Description
The item's descripton
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
ID
The ID (unique name) of this item
Declaration
public string ID { get; }Property Value
| Type | Description |
|---|---|
| System.String |
InventoryTexture
The item's inventory texture.
Declaration
public Texture InventoryTexture { get; set; }Property Value
| Type | Description |
|---|---|
| Texture |
IsCloned
Whether this item is a clone or not
Declaration
public bool IsCloned { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsStackable
Whether this item can be stacked or not
Declaration
public bool IsStackable { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Name
The item's name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Type
The item's EItemType.
Declaration
public EItemType Type { get; set; }Property Value
| Type | Description |
|---|---|
| EItemType |
Methods
AddTag(EItemTag)
Add a tag to this item
Declaration
public void AddTag(EItemTag tag)Parameters
| Type | Name | Description |
|---|---|---|
| EItemTag | tag | The tag to add |
AddToGame(String)
Add this item to the game.
alert
The item must be cloned first (if you're adding a new item to the game, you should clone it first anyway)
Declaration
public void AddToGame(string asName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | asName |
Clone()
Clone this item, allowing you to save modifications as a new Item.
Declaration
public Item Clone()Returns
| Type | Description |
|---|---|
| Item | The cloned Item |
HasTag(EItemTag)
Whether this item has a tag.
Declaration
public bool HasTag(EItemTag tag)Parameters
| Type | Name | Description |
|---|---|---|
| EItemTag | tag | The item tag to check |
Returns
| Type | Description |
|---|---|
| System.Boolean | Whether this item has the specified tag |
RemoveTag(EItemTag)
Remove a tag from this item
Declaration
public void RemoveTag(EItemTag tag)Parameters
| Type | Name | Description |
|---|---|---|
| EItemTag | tag | The tag to remove |