wiki.sine.space | sinespace

Difference between revisions of "Scripting/SScript"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/scene/sscript")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The 'Space' global accessible in every script (for C# scripts, this inherits from the [[Scripting/SpaceScript|SpaceScript]] base class)
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/scene/sscript
 
+
==Attributes==
+
 
+
{{ScriptFunction|SInventory|Inventory|{ get; }|Allows access to the users inventory}}
+
{{ScriptFunction|SPersistence|Persistence|{ get; }|Stores information between user sessions, and for other users}}
+
{{ScriptFunction|SScene|Scene|{ get; }|Allows access to the current scene graph (objects and avatars in the scene, and other information)}}
+
{{ScriptFunction|SHost|Host|{ get; }|Access information about the current scripting runtime host}}
+
{{ScriptFunction|SPhysics|Physics|{ get; }|Call physics-related commands, and variables, such as raycasting}}
+
{{ScriptFunction|SMath|Math|{ get; }|Math related functions (Sin, Cos, Tan, etc)}}
+
{{ScriptFunction|SString|String|{ get; }|Miscellaneous additional string functions (e.g. MD5Sum)}}
+
{{ScriptFunction|SInput|Input|{ get; }|Input device related functions (mouse position, keyboard state)}}
+
{{ScriptFunction|SCameraManager|CameraManager|{ get; }|Take and control the users camera}}
+
{{ScriptFunction|SWebService|WebServices|{ get; }|Call remote web services to designated hosts (will not work with arbitrary domains, see page for details)}}
+
{{ScriptFunction|SNetwork|Network|{ get; }|Send data to other clients through the region server}}
+
{{ScriptFunction|SResource|Resources[]|{ get; }|Access resources embedded in the Scripting Runtime component, such as sounds, textures & so forth}}
+
{{ScriptFunction|float|Time|{ get; }|The current viewer time - this will usually correlate with the number of seconds the player has been in the current scene, increments each frame, typically used for animation/tweening}}
+
{{ScriptFunction|DateTime|ServerTime|{ get; }|The current server time - usually UTC, as according to the login server.}}
+
{{ScriptFunction|float|DeltaTime|{ get; }|The current time between this frame, and the previous frame, as used in Update, LateUpdate events, if moving a object, you can multiply it by DeltaTime to get a consistent speed}}
+
{{ScriptFunction|void|Log|(string text);|Logs the message to the script debug console}}
+
 
+
=Members=
+
{{ScriptFunction|SResource|GetResource|{string name;}|Returns a resource with its name.|Space.Log(Space.GetResource("Texture").Name)<br>
+
''--Print "Texture" when it is exists.''
+
}}
+
 
+
{{ScriptFunction|void|Log|{DynValue text;}|Log a message to console.|Space.Log("Log")<br>
+
Space.Log("Log",true)
+
}}
+
 
+
=Properties=
+
 
+
{{ScriptFunction|string|RuntimeType|{get; }|Return current RuntimeType name.|Space.Log(Space.RuntimeType)
+
}}
+
 
+
{{ScriptFunction|string|Platform|{get; }|Return current platform name.|Space.Log(Space.Platform)
+
}}
+
 
+
{{ScriptFunction|string|TypeName|{get; }|Return the type name of the value.|Space.Log(Space.TypeName("123"))
+
}}
+
 
+
{{ScriptFunction|string|SessionID|{get; }|Return current SessionID.|Space.Log(Space.SessionID)
+
}}
+
 
+
{{ScriptFunction|bool|TrackingAllowed|{string key;}|Always return false on the main grid.|Space.Log(Space.TrackingAllowed("YourKey"))
+
}}
+
 
+
{{ScriptFunction|bool|InEditor|[get;]|Return true if in unity editor.|Space.Log(Space.InEditor)
+
}}
+
 
+
{{ScriptFunction|SResource[]|Resources|[get;]|Return all resources.|Space.Log(#Space.Resources)
+
}}
+
 
+
{{ScriptFunction|float|Time|[get;]|Returns time at the beginning of this frame.|Space.Log(Space.Time)
+
}}
+
 
+
{{ScriptFunction|string|ServerTime|[get;]|Returns current server time.|Space.Log(Space.ServerTime)
+
}}
+
 
+
{{ScriptFunction|string|LocalTime|[get;]|Returns current local time.|Space.Log(Space.LocalTime)
+
}}
+
 
+
{{ScriptFunction|int|ServerTimeUnix|[get;]|Returns server unix timestamp.|Space.Log(Space.ServerTimeUnix)
+
}}
+
 
+
{{ScriptFunction|int|LocalTimeUnix|[get;]|Returns local unix timestamp.|Space.Log(Space.LocalTimeUnix)
+
}}
+
 
+
{{ScriptFunction|float|DeltaTime|[get;]|The completion time in seconds since the last frame.|Space.Log(Space.DeltaTime)
+
}}
+
 
+
{{ScriptFunction|bool|PreviewServer|[get;]|Return true if in preview server.|Space.Log(Space.PreviewServer)
+
}}
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 07:13, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/scene/sscript