Sinespace Client 2025.3.19431
Client-side scripting for Sinespace
SineSpace.Scripting.Components.SFurniture Class Reference
Inheritance diagram for SineSpace.Scripting.Components.SFurniture:
ScriptClassComponent< T > ScriptClass< T > ScriptClassWrapper< T > ScriptClass

Public Member Functions

void StoreCustomData (string key, string value)
 Set custom key to furniture.
 
string GetCustomData (string key)
 Get custom data from furniture.
 
- Public Member Functions inherited from ScriptClassWrapper< T >
override void Initialise (SScript runtime, object wrapper)
 
- Public Member Functions inherited from ScriptClass
void ReportError (string error, bool fatal, UnityEngine.Object target=null)
 
void Initialise (SScript runtime, object wrapper)
 

Properties

int InventoryItemID [get]
 Return the inventory ID of furniture.
 
SRoomFloor Floor [get]
 Return an SRooomFloor component of the floor this furniture is placed on.
 
SCollider MainCollider [get]
 
- Properties inherited from ScriptClassComponent< T >
SGameObject GameObject [get]
 Return the GameObject which component added.
 
- Properties inherited from ScriptClass< T >
override bool Alive [get]
 Return if the component is alive.
 
- Properties inherited from ScriptClassWrapper< T >
_wrap [get]
 
- Properties inherited from ScriptClass
virtual bool Alive [get]
 
DynValue CachedData [get, set]
 

Additional Inherited Members

- Protected Member Functions inherited from ScriptClass
void Initialise (SScript runtime)
 

Member Function Documentation

◆ GetCustomData()

string SineSpace.Scripting.Components.SFurniture.GetCustomData ( string key)

Get custom data from furniture.

furniture = Space.Scene.Find(“Cube”).Furniture
&ndash;get the roomfurniture component.
Space.Log(furniture.GetCustomData(“custom key”))
&ndash;get the value from furniture by key.

◆ StoreCustomData()

void SineSpace.Scripting.Components.SFurniture.StoreCustomData ( string key,
string value )

Set custom key to furniture.

furniture = Space.Scene.Find(“Cube”).Furniture
&ndash;get the roomfurniture component on your furniture
furniture.StoreCustomData(“custom key”,”123”)
&ndash;set key and value to the furniture

Property Documentation

◆ Floor

SRoomFloor SineSpace.Scripting.Components.SFurniture.Floor
get

Return an SRooomFloor component of the floor this furniture is placed on.

◆ InventoryItemID

int SineSpace.Scripting.Components.SFurniture.InventoryItemID
get

Return the inventory ID of furniture.

furniture = Space.Scene.Find(“Cube”).Furniture
&ndash;get the roomfurniture component on your furniture
inventoryId = furniture.InventoryItemID
&ndash;get inventoryid of the furniture
Space.Log(inventoryId)
&ndash;print the inventory id.

◆ MainCollider

SCollider SineSpace.Scripting.Components.SFurniture.MainCollider
get