LogoLogo
Scripting DocsSupport
Scripting
Scripting
  • Sinespace Scripting Documentation
  • Client Scripting
    • Viewer
      • SDialogues
      • SInput
      • SShared
      • SUI
    • Network
      • SChat
      • SNetwork
      • SPhotos
      • SVideos
      • SWebService
    • Player
      • SEconomy
      • SGroup
      • SInventory
      • SProfile
      • SQuests
    • Region
      • SCameraManager
      • SGrid
      • SHost
      • SPersistence
      • SPhysics
      • SPostFX
      • SScene
      • SScript
      • SRenderSettings
    • Components
      • SAnimation
      • SAnimator
      • SAudioReactiveAnimation
      • SAudioReactiveBase
      • SAudioReactiveLight
      • SAudioReactiveMaterial
      • SAudioReactiveParticleSystem
      • SAudioReactiveTransform
      • SAudioSource
      • SBoxCollider
      • SBrowserSurface
      • SCamera
      • SCanvasGroup
      • SCapsuleCollider
      • SCharacterController
      • SClickable
      • SCloth
      • SCollider
      • SContentSizeFitter
      • SEmbeddedVideo
      • SEventCalendar
      • SFurniture
      • SGraphicRaycaster
      • SHingeJoint
      • SLight
      • SLineRenderer
      • SMeshRenderer
      • SModularVehicle
      • SNavMeshAgent
      • SNavMeshObstacle
      • SNetworking
      • SParticleSystem
      • SPlayableDirector
      • SPostProcessVolume
      • SRectTransform
      • SReflectionProbe
      • SRenderer
      • SRigidbody
      • SRoomFloor
      • SSceneBackgroundMusic
      • SScriptingData
      • SScriptingEvents
      • SScriptingResources
      • SScriptingRuntime
      • SSeat
      • SSkinnedMeshRenderer
      • SSphereCollider
      • SStateMachine
      • STerrain
      • STrailRenderer
      • SUIButton
      • SUICanvas
      • SUIDropdown
      • SUIImage
      • SUIInputField
      • SUILayout
      • SUIRawImage
      • SUIScrollbar
      • SUISlider
      • SUIText
      • SUIToggle
      • SUIToolTipHint
      • SVirtualCamera
      • SVoiceZone
    • Types
      • SAnimationState
      • SAnimatorStateInfo
      • SAvatar
      • SAvatarAppearance
      • SChatMessage
      • SColor
      • SCommandBuffer
      • SDateTime
      • SGameObject
      • SGenre
      • SGroupInfo
      • SInventoryItem
      • SJointLimits
      • SJointMotor
      • SJointSpring
      • SLandmark
      • SLayerMask
      • SMaterial
      • SMath
      • SMusicDirectory
      • SMusicStation
      • SMusicStationList
      • SNetworkMessageLua
      • SOutfit
      • SParticle
      • SPhysicsHit
      • SPublicRegion
      • SQuaternion
      • SRay
      • SRect
      • SResource
      • SScore
      • SScoreRank
      • SString
      • SSubRegion
      • STrackInfo
      • STuneIn
      • SUIRaycastResult
      • SUserRegions
      • SVector
      • SUserProfile
      • SSocialMedia
      • SWebResponse
  • Server Scripting
    • Library
      • SMath
    • Network
      • SShared
      • SWebservice
    • Region
      • SAvatar
      • SCell
      • SObject
      • SParcel
      • SParcelManager
      • SRegionScript
      • SScene
    • Storage
      • SDatabase
  • Guides
    • Persistence
    • Server Scripts
  • Sample Projects
    • Smart Lights
    • Trivia Box
  • Changelog
    • API Changelog
  • Support
    • Report An Issue
Powered by GitBook

Sinespace® is a registered trademark of Sine Wave Entertainment Ltd, All Rights Reserved.

On this page
  • Index
  • Functions Index
  • Properties Index
  • Functions
  • GetResource
  • CallScriptFunction
  • Reset
  • GetPublicVariable
  • SetPublicVariable
  • InvokeEvent
  • Properties
  • Resources
  • Enabled
  • ComponentName
  • GameObject

Was this helpful?

Export as PDF
  1. Client Scripting
  2. Components

SScriptingRuntime

Index

Functions Index

Function Name

Properties Index

Property Name

Functions

GetResource

Get the resource by its name and return it.

Parameter
Type
Description

resource = Space.Host.ExecutingObject.Script.GetResource("resource name")

CallScriptFunction

void CallScriptFunction (string name, params DynValue[] arguments) void CallScriptFunction (string name)

Call registered script function with specified arguments.

Parameter
Type
Description

resource = Space.Host.ExecutingObject.Script.CallScriptFunction("FunctionName")
--or
resource = Space.Host.ExecutingObject.Script.CallScriptFunction("FunctionName", tableWithArguments)

Reset

void Reset ()

Reset event members to their initial values.

Space.Host.ExecutingObject.Script.Reset()

GetPublicVariable

object GetPublicVariable (string name)

Gets the public variable by its name and return it.

Parameter
Type
Description

publicVariable = Space.Host.ExecutingObject.Script.GetPublicVariable("variableName")

SetPublicVariable

void SetPublicVariable (string name, DynValue property, bool persistent=false)

Set the property to public variable with name "name".

Parameter
Type
Description

Space.Host.ExecutingObject.Script.SetPublicVariable("VariableName",5,true)

InvokeEvent

void InvokeEvent (string name)

Invokes the event with the name "name".

Parameter
Type
Description

Space.Host.ExecutingObject.Script.InvokeEvent("EventName")

Properties

Resources

Return a list of resource.

tableResources = Space.Host.ExecutingObject.Script.Resources

Enabled

bool Enabled get set

Whether the scripting runtime component is Enabled.

Space.Host.ExecutingObject.Script.Enabled = true

ComponentName

string ComponentName get

The name of this component.

componentName = Space.Host.ExecutingObject.Script.ComponentName

GameObject

Property Description

theGameObject = Space.Host.ExecutingObject.Script.GameObject
PreviousSScriptingResourcesNextSSeat

Last updated 2 years ago

Was this helpful?

SResource (string name)

void (string name, params DynValue[] arguments) void (string name)

void ()

object (string name)

void (string name, DynValue property, bool persistent=false)

void (string name)

SResource[] get

bool get set

string get

SGameObject get

GetResource (string name)

[] Resources get

GameObject get

SResource
SResource
SGameObject
GetResource
CallScriptFunction
CallScriptFunction
Reset
GetPublicVariable
SetPublicVariable
InvokeEvent
Resources
Enabled
ComponentName
GameObject