SM Docs
Docs›Game›Userdata›ClientScriptableObject

ClientScriptableObject

Availability
Client only
Serializable
Yes
Associated namespace
sm.clientScriptableObject

A userdata object representing a scriptable object.

Values:

  • clientPublicData [ table ]

    • Get: (Client-Only) Returns public data from a client scriptable object.
    • Set: (Client-Only) Sets public data on a client scriptable object.

  • id [ number ]

    • Get: (Client-Only) Returns the id of a client scriptable object.

  • world [ World ]

    • Get: (Client-Only) Returns the worldId of a client scriptable object.

Operations:

Operation Returns Description
ClientScriptableObject == ClientScriptableObject boolean Checks if two instances of ClientScriptableObject refer to the same ClientScriptableObject.

Client-only

destroy

clientScriptableObject:destroy(  )

Destroys a client scriptable Object.

Parameters:

Name Type Description
clientScriptableObject ClientScriptableObject The scriptable object.

getClientPublicData

clientScriptableObject:getClientPublicData( scriptableObject )

Returns public data from a client scriptable object.

Parameters:

Name Type Description
scriptableObject ScriptableObject The scriptableObject.

Returns:

Type Description
table The client public data.

getData

clientScriptableObject:getData( scriptableObject )

Returns json data from a client scriptableObject.

Parameters:

Name Type Description
scriptableObject ScriptableObject The scriptableObject.

Returns:

Type Description
table The json data.

getId

clientScriptableObject:getId(  )

Returns the id of a client scriptable object.

Parameters:

Name Type Description
clientScriptableObject ClientScriptableObject The scriptable object.

Returns:

Name Type Description
id number The clientScriptableObject id.

getWorld

clientScriptableObject:getWorld( scriptableObject )

Returns the worldId of a client scriptable object.

Parameters:

Name Type Description
scriptableObject ScriptableObject The scriptable object.

Returns:

Name Type Description
world World The world.

setClientPublicData

clientScriptableObject:setClientPublicData( scriptableObject, data )

Sets public data on a client scriptable object.

Parameters:

Name Type Description
scriptableObject ScriptableObject The scriptableObject.
data table The client public data.