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|(int id, float value);|description|5=<pre></pre>|6=<pre></pre>}}
+
{{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|GetRegionTexture|(int id, float value);|description|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|(int id, float value);|description|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|GetOutfits|(int id, float value);|description|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|void|GetOutfits|(Closure onComplete);|Gets the Grid's outfits as a table of SOutfit which contain Outfit data. |5=<pre></pre>|6=<pre></pre>}}
  
  
 
=Public Attributes=
 
=Public Attributes=
{{ScriptFunction|int|OrientationRegion|{}|description|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|int|OrientationRegion|{}|Returns the Region ID of the Orientation Region|5=<pre></pre>|6=<pre></pre>}}
  
 
=Properties=
 
=Properties=
Line 30: Line 30:
 
{{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|5=<pre></pre>|6=<pre></pre>}}
  
{{ScriptFunction|int|DefaultRegion|{ get;}|Returns the ID of the Default Region.|5=<pre></pre>|6=<pre></pre>}}
+
{{ScriptFunction|int|DefaultRegion|{ get;}|Returns the Region ID of the Default Region.|5=<pre></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.|5=<pre></pre>|6=<pre></pre>}}
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 20:05, 17 March 2022

Public Member Functions

GetEnabledUserRegions

void GetEnabledUserRegions (Closure onComplete);

Gets an SUserRegions object which contains data about the user's regions.


GetRegionTexture

void GetRegionTexture (SPublicRegion region, Closure onComplete);

Returns the texture resource of the region using an SPublicRegion object.


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


Properties

IsWhiteLabel

bool IsWhiteLabel { get;}

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


PlayerIsAdmin

bool PlayerIsAdmin { get;}

Returns true if this player's Grid role is Admin.


PlayerIsModerator

bool PlayerIsModerator { get;}

Returns true if this player's Grid role is Moderator.


PlayerIsDeveloper

bool PlayerIsDeveloper { get;}

Returns true if this player's Grid role is Developer.


PlayerIsTrusted

bool PlayerIsTrusted { get;}

Returns true if this player's Grid role is Trusted.


Name

string Name { get;}

Returns the Grid's Name


SiteURL

string SiteURL { get;}

Returns the Grid's Site URL


DefaultRegion

int DefaultRegion { get;}

Returns the Region ID of the Default Region.


Avatars

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

Returns the IDs of all Avatars in the grid.