Skip to content

NetworkedObject

NetworkedObject is a base class for all object that's synchronized by the network.

Abstract Object

This object exists only to serve as a foundation for other objects. It cannot be accessed directly, but its properties are documented below.

Additionally, it cannot be created in the creator menu or with Instance.New().

Not newable

This object cannot be created by scripts using Instance.New().

Properties

Name : string

Name of this object

ClassName : string

Class name of this object

Shared : ScriptSharedTable

A shared table accessible by scripts.

NetworkedObjectID : string

Returns networked ID of this object. Networked ID are always unique per network session.

ObjectID : string

Returns object ID of this object. Object ID originates from the .poly file.

ExistInNetwork : boolean

Returns true if this object exists in network, false if this object is spawned by the local client.

Methods

IsA → boolean

Parameters: className [ string ]

Returns whether or not the instance is the specified class, this also checks for inheritance.

Clone → NetworkedObject

Parameters: parent [ NetworkedObject? ]

Clones the instance

Destroy → nil

Parameters: time [ number? ]

Destroys the instance (same as Delete method)

Delete → nil

Parameters: time [ number? ]

Deletes the instance (same as Destroy method)

Events

PropertyChanged

Parameters: propertyName [ string ]

Fires when a property of this object has changed

Renamed

Parameters: ``

Fires when this object has been renamed

TreeEntered

Parameters: ``

Fires when object enters the tree

TreeExited

Parameters: ``

Fires when object exit the tree (via reparent or delete)