Sinespace Client  2023.2.17543
Client-side scripting for Sinespace
SineSpace.Scripting.Scene.SScript Class Reference

Class accessible to all scripts More...

Public Member Functions

 SScript ()
 
object LoadExternalClass (string fullyQualifiedClassName, string assemblyName, bool tryGetTypeFirst=false)
 
string TypeName (DynValue dv)
 
bool TrackingAllowed (string key)
 Always returns false on the main grid. Tracking without explicit consent is a GPDR violation. More...
 
void TrackingRequest (string key, string privacynotice, Closure callback, bool force=false)
 Pops up a accept/deny request for tracking - EULA-style GPDR text More...
 
SResource GetResource (string name)
 
void LogEvent (string eventName, float value, SVector position)
 For white label grids - logs an event to the Analytics engine. More...
 
void Log (DynValue text, bool logToFile=false)
 
void Log (string text, bool logToFile=false)
 

Public Attributes

readonly SInventory Inventory
 
readonly SPersistence Persistence
 
readonly SScene Scene
 
readonly SGrid Grid
 
readonly SHost Host
 
readonly SPhysics Physics
 
readonly SMath Math
 
readonly SString String
 
readonly SInput Input
 
readonly SCameraManager Camera
 
readonly SWebService WebServices
 
readonly SNetwork Network
 
readonly SPostFX PostFX
 
readonly SAudioAnalyser AudioAnalyser
 
readonly STween Tween
 
readonly SUI UI
 
readonly SDialogues Dialogues
 
readonly SShared Shared
 
readonly SQuests Quests
 
readonly SEconomy Economy
 
readonly SGroup Groups
 
readonly SActivity Activity
 
readonly SRenderSettings RenderSettings
 
readonly SProfile Profile
 
readonly SPhotos Photos
 
readonly SVideos Videos
 
readonly SMusicDirectory MusicDirectory
 
readonly SJourney Journey
 
readonly SGameTester GameTester
 

Properties

string RuntimeType [get]
 
string Platform [get]
 
string SessionID [get]
 
bool InEditor [get]
 
int Version [get]
 The internal revision number of the release. Ties to release notes. More...
 
SResource[] Resources [get]
 
float Time [get]
 
string ServerTime [get]
 
string LocalTime [get]
 
float LoginTime [get]
 
int ServerTimeUnix [get]
 
int LocalTimeUnix [get]
 
float DeltaTime [get]
 
bool PreviewServer [get]
 
string ComponentName [get]
 

Detailed Description

Class accessible to all scripts

Constructor & Destructor Documentation

◆ SScript()

SineSpace.Scripting.Scene.SScript.SScript ( )

Member Function Documentation

◆ GetResource()

SResource SineSpace.Scripting.Scene.SScript.GetResource ( string  name)

◆ LoadExternalClass()

object SineSpace.Scripting.Scene.SScript.LoadExternalClass ( string  fullyQualifiedClassName,
string  assemblyName,
bool  tryGetTypeFirst = false 
)

◆ Log() [1/2]

void SineSpace.Scripting.Scene.SScript.Log ( DynValue  text,
bool  logToFile = false 
)

◆ Log() [2/2]

void SineSpace.Scripting.Scene.SScript.Log ( string  text,
bool  logToFile = false 
)

◆ LogEvent()

void SineSpace.Scripting.Scene.SScript.LogEvent ( string  eventName,
float  value,
SVector  position 
)

For white label grids - logs an event to the Analytics engine.

Parameters
eventData

◆ TrackingAllowed()

bool SineSpace.Scripting.Scene.SScript.TrackingAllowed ( string  key)

Always returns false on the main grid. Tracking without explicit consent is a GPDR violation.

On white labels returns true if the user has opted in to tracking as part of their registration.

◆ TrackingRequest()

void SineSpace.Scripting.Scene.SScript.TrackingRequest ( string  key,
string  privacynotice,
Closure  callback,
bool  force = false 
)

Pops up a accept/deny request for tracking - EULA-style GPDR text

Parameters
key
privacynotice
callback

◆ TypeName()

string SineSpace.Scripting.Scene.SScript.TypeName ( DynValue  dv)

Member Data Documentation

◆ Activity

readonly SActivity SineSpace.Scripting.Scene.SScript.Activity

◆ AudioAnalyser

readonly SAudioAnalyser SineSpace.Scripting.Scene.SScript.AudioAnalyser

◆ Camera

readonly SCameraManager SineSpace.Scripting.Scene.SScript.Camera

◆ Dialogues

readonly SDialogues SineSpace.Scripting.Scene.SScript.Dialogues

◆ Economy

readonly SEconomy SineSpace.Scripting.Scene.SScript.Economy

◆ GameTester

readonly SGameTester SineSpace.Scripting.Scene.SScript.GameTester

◆ Grid

readonly SGrid SineSpace.Scripting.Scene.SScript.Grid

◆ Groups

readonly SGroup SineSpace.Scripting.Scene.SScript.Groups

◆ Host

readonly SHost SineSpace.Scripting.Scene.SScript.Host

◆ Input

readonly SInput SineSpace.Scripting.Scene.SScript.Input

◆ Inventory

readonly SInventory SineSpace.Scripting.Scene.SScript.Inventory

◆ Journey

readonly SJourney SineSpace.Scripting.Scene.SScript.Journey

◆ Math

readonly SMath SineSpace.Scripting.Scene.SScript.Math

◆ MusicDirectory

readonly SMusicDirectory SineSpace.Scripting.Scene.SScript.MusicDirectory

◆ Network

readonly SNetwork SineSpace.Scripting.Scene.SScript.Network

◆ Persistence

readonly SPersistence SineSpace.Scripting.Scene.SScript.Persistence

◆ Photos

readonly SPhotos SineSpace.Scripting.Scene.SScript.Photos

◆ Physics

readonly SPhysics SineSpace.Scripting.Scene.SScript.Physics

◆ PostFX

readonly SPostFX SineSpace.Scripting.Scene.SScript.PostFX

◆ Profile

readonly SProfile SineSpace.Scripting.Scene.SScript.Profile

◆ Quests

readonly SQuests SineSpace.Scripting.Scene.SScript.Quests

◆ RenderSettings

readonly SRenderSettings SineSpace.Scripting.Scene.SScript.RenderSettings

◆ Scene

readonly SScene SineSpace.Scripting.Scene.SScript.Scene

◆ Shared

readonly SShared SineSpace.Scripting.Scene.SScript.Shared

◆ String

readonly SString SineSpace.Scripting.Scene.SScript.String

◆ Tween

readonly STween SineSpace.Scripting.Scene.SScript.Tween

◆ UI

readonly SUI SineSpace.Scripting.Scene.SScript.UI

◆ Videos

readonly SVideos SineSpace.Scripting.Scene.SScript.Videos

◆ WebServices

readonly SWebService SineSpace.Scripting.Scene.SScript.WebServices

Property Documentation

◆ ComponentName

string SineSpace.Scripting.Scene.SScript.ComponentName
get

◆ DeltaTime

float SineSpace.Scripting.Scene.SScript.DeltaTime
get

◆ InEditor

bool SineSpace.Scripting.Scene.SScript.InEditor
get

◆ LocalTime

string SineSpace.Scripting.Scene.SScript.LocalTime
get

◆ LocalTimeUnix

int SineSpace.Scripting.Scene.SScript.LocalTimeUnix
get

◆ LoginTime

float SineSpace.Scripting.Scene.SScript.LoginTime
get

◆ Platform

string SineSpace.Scripting.Scene.SScript.Platform
get

◆ PreviewServer

bool SineSpace.Scripting.Scene.SScript.PreviewServer
get

◆ Resources

SResource [] SineSpace.Scripting.Scene.SScript.Resources
get

◆ RuntimeType

string SineSpace.Scripting.Scene.SScript.RuntimeType
get

◆ ServerTime

string SineSpace.Scripting.Scene.SScript.ServerTime
get

◆ ServerTimeUnix

int SineSpace.Scripting.Scene.SScript.ServerTimeUnix
get

◆ SessionID

string SineSpace.Scripting.Scene.SScript.SessionID
get

◆ Time

float SineSpace.Scripting.Scene.SScript.Time
get

◆ Version

int SineSpace.Scripting.Scene.SScript.Version
get

The internal revision number of the release. Ties to release notes.