Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Function |
---|
Property |
---|
Parameter | Type | Description |
---|---|---|
Table AllParcels get
SObject GetObject (string id)
Function Description
Table Objects get
Property Description
void Log (string message)
Log a message to console. (only works on preview grid)
void SubscribeToNetwork (string key)
Subscribe to network messages on "key".
void UnsubscribeFromNetwork (string key)
Unsubscribe from network messages on "key".
void SendMessageToAllClientScripts (string messageName, Table message)
Sends a network message to all client scripts.
void SendMessageToClientScripts (int playerID, string messageName, Table message)
Sends a network message to a client script belonging to a specific player
void StartCoroutine (DynValue coroutine, DynValue parameter=default(DynValue)) void StartCoroutine (string name, DynValue parameter=default(DynValue))
Runs the given function as a coroutine. A parameter is optional.
string ScriptID get
Returns a unique identifier of this script runtime. (can be found in "/list_scripts" window on preview.)
int InstanceID get
Returns a unique identifier for the instance of the region. Useful in the case of multiple shards/instances being used. InstanceID does not necessarily equal to the RegionID, even if there's only one instance running.
int RegionID get
Returns a unique identifier for the region. (Same ID seen in curator)
SScene Scene get
Access to the SScene class methods and properties.
SDatabase Database get
Access to the SDatabase class methods and properties.
SMath Math get
Access to the SMath class methods and properties.
SShared Shared get
Access to the SShared class methods and properties.
SWebservice WebServices get
Access to the SWebservice class methods and properties.
string RuntimeType get
Returns "Server" if this script is a Server script
bool InEditor get
Returns true if in Editor. (this will return false on server scripts)
float TimeSinceAwake get
Time, in seconds, since this script runtime has been awake.
string DateTimeUTC get
Returns a string of the current Date/Time in UTC
int LocalTimeUnix get
Returns the current Unix time (in seconds) (same as ServerTimeUnix)
int ServerTimeUnix get
Returns the current Unix time (in seconds) (same as LocalTimeUnix)
Action< int > OnAvatarJoin
An event function which will be called whenever an Avatar joins and will also contain the Avatar's ID as a parameter.
Action< int > OnAvatarLeave
An event function which will be called whenever an Avatar leaves and will also contain the Avatar's ID as a parameter.
Action< string, Table > OnScriptServerMessage
An event function which will be called whenever the server script receives a Network Message, and will contain the network message key String and message Table as a parameter.
string ID get
Property Description
string Name get
Property Description
string DescriptionName get
Property Description
bool ForSale get
Property Description
int GoldSalePrice get
Property Description
int SilverSalePrice get
Property Description
int GoldRentalPrice get
Property Description
int SilverRentalPrice get
Property Description
string GetProperty (string property)
Function Description
void SetProperty (string property, string value)
Function Description
SCell Cell get
Property Description
string ID get
Property Description
string Floor get
Property Description
Vector3 Position get
set
Property Description
Quaternion Rotation get
set
Property Description
Vector3 Scale get
set
Property Description
int Player get
Property Description
int InventoryID get
Property Description
int ItemID get
Property Description
Bounds Bounds get
Property Description
int ConnectedAvatars get
Returns the number of Avatars connected to the region.
Table Avatars get
Returns a table of SAvatar objects currently in the region
Table Cells get
Returns a table of SCell objects. (Not all cells are available at all times, a client on this server must be within 384m of a cell in order for it to exist.)
Access to the SParcelManager class.
Function |
---|
Property |
---|
Parameter | Type | Description |
---|---|---|
Function |
---|
Property |
---|
Event | Description |
---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Property |
---|
Property |
---|
Function |
---|
Property |
---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Property |
---|
Parcels get
SObject GetObject (string id)
Table Objects get
void Log (string message)
void SubscribeToNetwork (string key)
void UnsubscribeFromNetwork (string key)
void SendMessageToAllClientScripts (string messageName, Table message)
void SendMessageToClientScripts (int playerID, string messageName, Table message)
void StartCoroutine (DynValue coroutine, DynValue parameter=default(DynValue)) void StartCoroutine (string name, DynValue parameter=default(DynValue))
string ScriptID get
int InstanceID get
int RegionID get
SScene Scene get
SDatabase Database get
SMath Math get
SShared Shared get
SWebservice WebServices get
string RuntimeType get
bool InEditor get
float TimeSinceAwake get
string DateTimeUTC get
int LocalTimeUnix get
int ServerTimeUnix get
Action< int > OnAvatarJoin \ Action< int > OnAvatarLeave \ Action< string, Table > OnScriptServerMessage
An event function which will be called whenever an Avatar joins and will also contain the Avatar's ID as a parameter.
string ID get
string Name get
string DescriptionName get
bool ForSale get
int GoldSalePrice get
int SilverSalePrice get
int GoldRentalPrice get
int SilverRentalPrice get
int ID get
Vector3 Position get
Vector3 Velocity get
Quaternion Rotation get
string Username get
string Title get
string GetProperty (string property)
void SetProperty (string property, string value)
SCell Cell get
string ID get
string Floor get
Vector3 Position get
set
Quaternion Rotation get
set
Vector3 Scale get
set
int Player get
int InventoryID get
int ItemID get
Bounds Bounds get
int get
Table get
Table get
SParcelManager get