# SInventoryItem

## Index

### Functions Index

| Function Name                                              |
| ---------------------------------------------------------- |
| bool [**StoreCustomData** ](#storecustomdata)(string data) |
| void [**Use** ](#use)()                                    |
| void [**Delete** ](#delete)()                              |

### Properties Index

| Property Name                                |
| -------------------------------------------- |
| long [**MasterID** ](#masterid)`get`         |
| long [**PlayerItemID** ](#playeritemid)`get` |
| string [**Name** ](#name)`get`               |
| string [**Description** ](#description)`get` |
| string [**Brand** ](#brand)`get`             |
| string [**CustomData** ](#customdata)`get`   |

## Functions

### StoreCustomData

bool **StoreCustomData** (string data)

*Updates the inventory items custom data, and requests a synchronisation with the inventory server. It may not update on the server immediately, but all local calls will reflect the new data. Note: this request can be rate limited and should only be called from a user initiated action (such as clicking a button). Updates to custom data must not be initiated on a timer or regular automatic event. Access to this function can be blacklisted to specific creators if abused.*

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
Items[1].StoreCustomData('data1data2data3')
```

{% endtab %}
{% endtabs %}

### Use

void **Use** ()

*Player will 'Use' this item. (White-label only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
Items[1].Use() 
```

{% endtab %}
{% endtabs %}

### Delete

void **Delete** ()

*Player will 'Delete' this item. (White-label only)*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
Items[1].Delete()
```

{% endtab %}
{% endtabs %}

## Properties

### MasterID

long **MasterID** `get`

*The master ID for this item - also known as the Curator ID or Item ID, this is the ID for the master item from which this copy exists.*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
iMasterID = Items[1].MasterID
```

{% endtab %}
{% endtabs %}

### PlayerItemID

long **PlayerItemID** `get`

*The instance ID for this item - this is guaranteed to be unique per inventory item*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
iPlayerItemID= Items[1].PlayerItemID
```

{% endtab %}
{% endtabs %}

### Name

string **Name** `get`

*Returns the name of the inventory item*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
iName= Items[1].Name
```

{% endtab %}
{% endtabs %}

### Description

string **Description** `get`

*Returns the registered description of the inventory item in the users locale*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
iDescription=Items[1].Description
```

{% endtab %}
{% endtabs %}

### Brand

string **Brand** `get`

*Returns brand information about the item*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
iBrand = Items[1].Brand
```

{% endtab %}
{% endtabs %}

### CustomData

string **CustomData** `get`

*Returns any custom data associated with this item, typically used for 'game' items*

{% tabs %}
{% tab title="Lua" %}

```lua
Items = Space.Inventory.Items
iCustomData = Items[1].CustomData
```

{% endtab %}
{% endtabs %}