wiki.sine.space | sinespace

Difference between revisions of "Scripting/SGrid"

From wiki.sine.space
Jump to: navigation, search
Line 2: Line 2:
 
=Public Member Functions=
 
=Public Member Functions=
  
{{ScriptFunction|void|GetEnabledUserRegions|(Closure onComplete);|Gets an SUserRegions object which contains data about the user's regions.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|void|GetEnabledUserRegions|(Closure onComplete);|Gets an SUserRegions object which contains data about the user's regions (the information in the "Room List" window).|5=<pre></pre>|6=<pre></pre>}}
  
{{ScriptFunction|void|GetRegionTexture|(SPublicRegion region, Closure onComplete);|Returns the texture resource of the region using an SPublicRegion object.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|void|GetRegionTexture|(SPublicRegion region, Closure onComplete);|Returns the texture resource of the region using an SPublicRegion object (the information in the "Room List" window).|5=<pre></pre>|6=<pre></pre>}}
  
 
{{ScriptFunction|void|GetRegionTexture|(string json, Closure onComplete);|Returns the texture resource of the region using a json string.|5=<pre></pre>|6=<pre></pre>}}
 
{{ScriptFunction|void|GetRegionTexture|(string json, Closure onComplete);|Returns the texture resource of the region using a json string.|5=<pre></pre>|6=<pre></pre>}}
Line 12: Line 12:
  
 
=Public Attributes=
 
=Public Attributes=
{{ScriptFunction|int|OrientationRegion|{}|Returns the Region ID of the Orientation Region|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|int|OrientationRegion|{}|Returns the Region ID of the Orientation Region|5=<pre> orientationRegion = Space.Grid.OrientationRegion</pre>|6=<pre></pre>}}
  
 
=Properties=
 
=Properties=
  
{{ScriptFunction|bool|IsWhiteLabel|{ get;}|Returns true if this Grid is a white-label Grid. |5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|bool|IsWhiteLabel|{ get;}|Returns true if this Grid is a white-label Grid. |5=<pre>isWhiteLabel = Space.Grid.IsWhiteLabel</pre>|6=<pre></pre>}}
  
{{ScriptFunction|bool|PlayerIsAdmin|{ get;}|Returns true if this player's Grid role is Admin.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|bool|PlayerIsAdmin|{ get;}|Returns true if this player's Grid role is Admin.(white-label grid only)|5=<pre>isAdmin = Space.Grid.PlayerIsAdmin</pre>|6=<pre></pre>}}
  
{{ScriptFunction|bool|PlayerIsModerator|{ get;}|Returns true if this player's Grid role is Moderator.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|bool|PlayerIsModerator|{ get;}|Returns true if this player's Grid role is Moderator. (white-label grid only) |5=<pre>isModerator = Space.Grid.PlayerIsModerator</pre>|6=<pre></pre>}}
  
{{ScriptFunction|bool|PlayerIsDeveloper|{ get;}|Returns true if this player's Grid role is Developer.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|bool|PlayerIsDeveloper|{ get;}|Returns true if this player's Grid role is Developer.(white-label grid only)|5=<pre>isDeveloper = Space.Grid.PlayerIsDeveloper</pre>|6=<pre></pre>}}
  
{{ScriptFunction|bool|PlayerIsTrusted|{ get;}|Returns true if this player's Grid role is Trusted.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|bool|PlayerIsTrusted|{ get;}|Returns true if this player's Grid role is Trusted.(white-label grid only)|5=<pre>isTrusted = Space.Grid.PlayerIsTrusted</pre>|6=<pre></pre>}}
  
{{ScriptFunction|string|Name|{ get;}|Returns the Grid's Name|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|string|Name|{ get;}|Returns the Grid's Name. (white-label grid only)|5=<pre>gridName = Space.Grid.Name</pre>|6=<pre></pre>}}
  
{{ScriptFunction|string|SiteURL|{ get;}|Returns the Grid's Site URL|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|string|SiteURL|{ get;}|Returns the Grid's Site URL. (white-label grid only)|5=<pre>siteUrl = Space.Grid.SiteURL</pre>|6=<pre></pre>}}
  
{{ScriptFunction|int|DefaultRegion|{ get;}|Returns the Region ID of the Default Region.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|int|DefaultRegion|{ get;}|Returns the Region ID of the Default Region. (white-label grid only)|5=<pre>defaultRegion = Space.Grid.DefaultRegion</pre>|6=<pre></pre>}}
  
{{ScriptFunction|int[]|Avatars|{ get;}|Returns the IDs of all Avatars in the grid.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|int[]|Avatars|{ get;}|Returns the IDs of all Avatars in the grid. (white-label grid only)|5=<pre>avatars = Space.Grid.Avatars</pre>|6=<pre></pre>}}
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 06:02, 18 March 2022

Public Member Functions

GetEnabledUserRegions

void GetEnabledUserRegions (Closure onComplete);

Gets an SUserRegions object which contains data about the user's regions (the information in the "Room List" window).


GetRegionTexture

void GetRegionTexture (SPublicRegion region, Closure onComplete);

Returns the texture resource of the region using an SPublicRegion object (the information in the "Room List" window).


GetRegionTexture

void GetRegionTexture (string json, Closure onComplete);

Returns the texture resource of the region using a json string.


GetOutfits

void GetOutfits (Closure onComplete);

Gets the Grid's outfits as a table of SOutfit which contain Outfit data.



Public Attributes

OrientationRegion

int OrientationRegion {}

Returns the Region ID of the Orientation Region

 orientationRegion = Space.Grid.OrientationRegion


Properties

IsWhiteLabel

bool IsWhiteLabel { get;}

Returns true if this Grid is a white-label Grid.

isWhiteLabel = Space.Grid.IsWhiteLabel


PlayerIsAdmin

bool PlayerIsAdmin { get;}

Returns true if this player's Grid role is Admin.(white-label grid only)

isAdmin = Space.Grid.PlayerIsAdmin


PlayerIsModerator

bool PlayerIsModerator { get;}

Returns true if this player's Grid role is Moderator. (white-label grid only)

isModerator = Space.Grid.PlayerIsModerator


PlayerIsDeveloper

bool PlayerIsDeveloper { get;}

Returns true if this player's Grid role is Developer.(white-label grid only)

isDeveloper = Space.Grid.PlayerIsDeveloper


PlayerIsTrusted

bool PlayerIsTrusted { get;}

Returns true if this player's Grid role is Trusted.(white-label grid only)

isTrusted = Space.Grid.PlayerIsTrusted


Name

string Name { get;}

Returns the Grid's Name. (white-label grid only)

gridName = Space.Grid.Name


SiteURL

string SiteURL { get;}

Returns the Grid's Site URL. (white-label grid only)

siteUrl = Space.Grid.SiteURL


DefaultRegion

int DefaultRegion { get;}

Returns the Region ID of the Default Region. (white-label grid only)

defaultRegion = Space.Grid.DefaultRegion


Avatars

[[Scripting/int[]|int[]]] Avatars { get;}

Returns the IDs of all Avatars in the grid. (white-label grid only)

avatars = Space.Grid.Avatars