# SFurniture

## Index

### Functions Index

| Function Name                                                           |
| ----------------------------------------------------------------------- |
| void [**StoreCustomData** ](#storecustomdata)(string key, string value) |
| string [**GetCustomData** ](#getcustomdata)(string key)                 |

### Properties Index

| Property Name                                     |
| ------------------------------------------------- |
| int [**InventoryItemID** ](#inventoryitemid)`get` |
| SRoomFloor [**Floor** ](#floor)`get`              |
| SCollider [**MainCollider** ](#maincollider)`get` |
| SGameObject [**GameObject** ](#gameobject)`get`   |

## Functions

### StoreCustomData

void **StoreCustomData** (string key, string value)

_Function Description_

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

{% tabs %}
{% tab title="Lua" %}
```lua
Space.Host.ExecutingObject.Furniture.StoreCustomData("AKey", "AValue")
```
{% endtab %}
{% endtabs %}

### GetCustomData

string **GetCustomData** (string key)

_Function Description_

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

{% tabs %}
{% tab title="Lua" %}
```lua
theValue = Space.Host.ExecutingObject.Furniture.GetCustomData("AKey")
```
{% endtab %}
{% endtabs %}

## Properties

### InventoryItemID

int **InventoryItemID** `get`

_Return the inventory ID of furniture._

{% tabs %}
{% tab title="Lua" %}
```lua
inventoryID = Space.Host.ExecutingObject.Furniture.InventoryItemID
```
{% endtab %}
{% endtabs %}

### Floor

[SRoomFloor](sroomfloor) **Floor** `get`

_Return an SRoomFloor component of the floor this furniture is placed on._

{% tabs %}
{% tab title="Lua" %}
```lua
sRoomFloor = Space.Host.ExecutingObject.Furniture.Floor
```
{% endtab %}
{% endtabs %}

### MainCollider

[SCollider](scollider) **MainCollider** `get`

_Property Description_

{% tabs %}
{% tab title="Lua" %}
```lua
collider = Space.Host.ExecutingObject.Furniture.MainCollider
```
{% endtab %}
{% endtabs %}

### GameObject

[SGameObject](../types/sgameobject) **GameObject** `get`

_Property Description_

{% tabs %}
{% tab title="Lua" %}
```lua
theGameObject = Space.Host.ExecutingObject.Furniture.GameObject
```
{% endtab %}
{% endtabs %}
