Revision as of 13:56, 22 February 2022

Public Member Functions

Log

void Log (string message);

Log a message to console. (only works on preview grid)

Space.Log("Log")

--Clicking the object will make the server script log "Test Message" on all clients

--server script

function OnScriptServerMessage(key, table) 
  
  if key == "testKey" then
  Space.Log("Message:" .. table[1])
  end

end




--client script

thisObject = Space.Host.ExecutingObject

OnClickFunction = function()

Space.Network.SendNetworkMessage("testKey",{"Test Message"})  

end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

SubscribeToNetwork

void SubscribeToNetwork (string key);

Subscribe to network messages on "key".

Space.SubscribeToNetwork("thekey")

UnsubscribeFromNetwork

void UnsubscribeFromNetwork (string key);

Unsubscribe from network messages on "key".

Space.UnsubscribeFromNetwork("thekey")

SendMessageToAllClientScripts

void SendMessageToAllClientScripts (string messageName, Table message);

Sends a network message to all client scripts.

Space.SendMessageToAllClientScripts("thekey",{"themessage"})

SendMessageToClientScripts

void SendMessageToClientScripts (int playerID, string messageName, Table message);

Sends a network message to a client script belonging to a specific player

Space.SendMessageToAllClientScripts(APlayerID,"thekey",{"themessage"})

StartCoroutine

void StartCoroutine (string name, DynValue parameter=default(DynValue));

Runs the given function as a coroutine. A parameter is optional.

Space.StartCoroutine("AFunctionName")

Public Attributes

ScriptID

string ScriptID { get; }

Returns a unique identifier of this script runtime.

scriptID = Space.ScriptID

InstanceID

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.

instance = Space.InstanceID

RegionID

int RegionID { get; }

Returns a unique identifier for the region. (Same ID seen in curator)

region = Space.RegionID

Scene

SScene Scene { get; }

Access to the SScene class methods and properties.

Space.Scene

Database

SDatabase Database { get; }

Access to the SDatabase class methods and properties.

Space.Database

Math

SMath Math { get; }

Access to the SMath class methods and properties.

Space.Math

Shared

SShared Shared { get; }

Access to the SShared class methods and properties.

Space.Shared

WebServices

SWebservice WebServices { get; }

Access to the SWebservice class methods and properties.

Space.WebServices

RuntimeType

string RuntimeType { get;}

Returns "Server" if this script is a Server script

type = Space.RuntimeType

InEditor

bool InEditor { get; }

Returns true if in Editor. (this will return false on server scripts)

IsInEditor = Space.InEditor

TimeSinceAwake

float TimeSinceAwake { get;}

Time, in seconds, since this script runtime has been awake.

SecondsAwake = Space.TimeSinceAwake

DateTimeUTC

string DateTimeUTC { get; }

Returns a string of the current Date/Time in UTC

DateAndTime = Space.DateTimeUTC

LocalTimeUnix

int LocalTimeUnix { get; }

Returns the current Unix time (in seconds) (same as ServerTimeUnix)

unixtime = Space.LocalTimeUnix

ServerTimeUnix

int ServerTimeUnix { get; }

Returns the current Unix time (in seconds) (same as LocalTimeUnix)

unixtime = Space.ServerTimeUnix

Events

Server script events are "Magic methods" which, unlike client scripts, you don't have to bind or subscribe to. They will be called as long as you have their methods implemented in your server script.

OnAvatarJoin

[[Scripting/Action<int>|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.

function OnAvatarJoin(playerID)

player = playerID


end

OnAvatarLeave

[[Scripting/Action<int>|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.

function OnAvatarLeave(playerID)

player = playerID


end

OnScriptServerMessage

[[Scripting/Action<string, Table>|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.

function OnScriptServerMessage(key, table) 

theKeyString = key
theSNetworkMessageTable = table

end

Navigation

User Portal

Creation Portal

Tools

Difference between revisions of "Scripting/Server/SRegionScript"