wiki.sine.space | sinespace

Difference between revisions of "Scripting/Server/SScene"

From wiki.sine.space
Jump to: navigation, search
(Created page with " =Public Member Functions= {{ScriptFunction|Table|GeneratePathTo|(int id, float value);|Returns a Table with a path generated between two given Vectors.|5=<pre>Space.Scene.Ge...")
 
Line 6: Line 6:
 
=Properties=
 
=Properties=
  
{{ScriptFunction|int|ConnectedAvatars|{ get;}|Returns the number of Avatars connected to the region.|5=<pre>numOfAvatars = Space.Scene.ConnectedAvatars</pre>|6=<pre></pre>}}
+
{{ScriptFunction|int|ConnectedAvatars|{ get;}|Returns the number of Avatars connected to the region.|5=<pre>numOfAvatars = Space.Scene.ConnectedAvatars</pre>|6=<pre>function OnAvatarJoin(id)
 +
  local numOfAvatars = Space.Scene.ConnectedAvatars
 +
  Space.Log("Avatar with ID " .. id .. "has joined")
 +
  Space.Log("Number of avatars connected: " .. numOfAvatars)
 +
end</pre>}}
  
  

Revision as of 20:42, 24 February 2022

Public Member Functions

GeneratePathTo

Table GeneratePathTo (int id, float value);

Returns a Table with a path generated between two given Vectors.

Space.Scene.GeneratePathTo(FirstVector, SecondVector)


Properties

ConnectedAvatars

int ConnectedAvatars { get;}

Returns the number of Avatars connected to the region.

numOfAvatars = Space.Scene.ConnectedAvatars


function OnAvatarJoin(id)
  local numOfAvatars = Space.Scene.ConnectedAvatars
  Space.Log("Avatar with ID " .. id .. "has joined")
  Space.Log("Number of avatars connected: " .. numOfAvatars)
end


Avatars

Table Avatars { get;}

Returns a table of SAvatar objects currently in the region

currentAvatars = Space.Scene.Avatars


Cells

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.)

cellsTable = Space.Scene.Cells


Parcels

SParcelManager Parcels { get;}

Access to the SParcelManager class.

Space.Scene.Parcels