wiki.sine.space | sinespace

Difference between revisions of "Scripting/Reference"

From wiki.sine.space
Jump to: navigation, search
m
Line 5: Line 5:
  
 
Full Class List (Automated Documentation): http://space-files.s3.amazonaws.com/docs/client-scripting/annotated.html
 
Full Class List (Automated Documentation): http://space-files.s3.amazonaws.com/docs/client-scripting/annotated.html
 +
 +
==Component Classes==
 +
* [[Scripting/SAnalyticsEvent]]
 +
* [[Scripting/SAnimation]]
 +
* [[Scripting/SAnimator]]
 +
* [[Scripting/SAttachmentHelper]]
 +
* [[Scripting/SAudioReactiveAnimation]]
 +
* [[Scripting/SAudioReactiveBase]]
 +
* [[Scripting/SAudioReactiveLight]]
 +
* [[Scripting/SAudioReactiveMaterial]]
 +
* [[Scripting/SAudioReactiveParticleSystem]]
 +
* [[Scripting/SAudioReactiveTransform]]
 +
* [[Scripting/SAudioSource]]
 +
* [[Scripting/SAXModel]]
 +
* [[Scripting/SBoxCollider]]
 +
* [[Scripting/SBrowserSurface]]
 +
* [[Scripting/SCamera]]
 +
* [[Scripting/SCanvasGroup]]
 +
* [[Scripting/SCapsuleCollider]]
 +
* [[Scripting/SCharacterController]]
 +
* [[Scripting/SClickable]]
 +
* [[Scripting/SCloth]]
 +
* [[Scripting/SCollider]]
 +
* [[Scripting/SComponentBase]]
 +
* [[Scripting/SEmbeddedVideo]]
 +
* [[Scripting/SEventCalendar]]
 +
* [[Scripting/SFurniture]]
 +
* [[Scripting/SGraphicRaycaster]]
 +
* [[Scripting/SHingeJoint]]
 +
* [[Scripting/SLight]]
 +
* [[Scripting/SLineRenderer]]
 +
* [[Scripting/SMeshRenderer]]
 +
* [[Scripting/SModularVehicle]]
 +
* [[Scripting/SNavMeshAgent]]
 +
* [[Scripting/SNavMeshObstacle]]
 +
* [[Scripting/SNetworking]]
 +
* [[Scripting/SParticleSystem]]
 +
* [[Scripting/SPlayableDirector]]
 +
* [[Scripting/SPostProcessVolume]]
 +
* [[Scripting/SRectTransform]]
 +
* [[Scripting/SReflectionProbe]]
 +
* [[Scripting/SRenderer]]
 +
* [[Scripting/SRigidbody]]
 +
* [[Scripting/SRoomFloor]]
 +
* [[Scripting/SSceneBackgroundMusic]]
 +
* [[Scripting/SScriptingData]]
 +
* [[Scripting/SScriptingEvents]]
 +
* [[Scripting/SScriptingResources]]
 +
* [[Scripting/SScriptingRuntime]]
 +
* [[Scripting/SSeat]]
 +
* [[Scripting/SSkinnedMeshRenderer]]
 +
* [[Scripting/SSphereCollider]]
 +
* [[Scripting/SStateMachine]]
 +
* [[Scripting/STerrain]]
 +
* [[Scripting/STrailRenderer]]
 +
* [[Scripting/SUIButton]]
 +
* [[Scripting/SUICanvas]]
 +
* [[Scripting/SUIDropdown]]
 +
* [[Scripting/SUIImage]]
 +
* [[Scripting/SUIInputField]]
 +
* [[Scripting/SUILayout]]
 +
* [[Scripting/SUIRawImage]]
 +
* [[Scripting/SUIScrollbar]]
 +
* [[Scripting/SUISlider]]
 +
* [[Scripting/SUIText]]
 +
* [[Scripting/SUIToggle]]
 +
* [[Scripting/SVirtualCamera]]
 +
* [[Scripting/SVoiceZone]]
 +
  
 
==Classes==
 
==Classes==
Line 57: Line 126:
 
* [[Scripting/SDialogues]] Input dialoges/confirmation boxes
 
* [[Scripting/SDialogues]] Input dialoges/confirmation boxes
  
==Component Classes==
+
 
* [[Scripting/SAnimator]] Access to Animator state machines
+
 
* [[Scripting/SAnimation]]
+
* [[Scripting/SAnimationState]]
+
* [[Scripting/SAudioSource]] Audio Source & Playback
+
* [[Scripting/SAudioReactiveTransform]]
+
* [[Scripting/SAudioReactiveMaterial]]
+
* [[Scripting/SAudioReactiveLight]]
+
* [[Scripting/SAudioReactiveBase]]
+
* [[Scripting/SAudioReactiveParticleSystem]]
+
* [[Scripting/SAudioReactiveAnimation]]
+
* [[Scripting/SVoiceZone]]
+
* [[Scripting/SEmbeddedVideo]]
+
* [[Scripting/SBrowserSurface]] Turn a surface into a browser
+
* [[Scripting/SCamera]] Camera controls (e.g. Field of View, Orthographic rendering, etc.)
+
* [[Scripting/VirtualCamera]]
+
* [[Scripting/SCharacterController]]
+
* [[Scripting/SClickable]] Actions triggered by clicking on the GameObject
+
* [[Scripting/SCloth]]
+
* [[Scripting/SCollider]]
+
* [[Scripting/SphereCollider]]
+
* [[Scripting/SCapsuleCollider]]
+
* [[Scripting/SBoxCollider]]
+
* [[Scripting/SLight]] Access to the Light properties.
+
** [[Scripting/SLightType]]
+
* [[Scripting/SNavMeshAgent]]
+
* [[Scripting/SNavMeshObstacle]]
+
* [[Scripting/SParticleSystem]]
+
* [[Scripting/SCanvasGroup]]
+
* [[Scripting/SPostProcessVolume]]
+
* [[Scripting/SRenderer]] Access to the renderer of an object.
+
* [[Scripting/SRigidbody]]
+
* [[Scripting/RoomFloor]]
+
* [[Scripting/SReflectionProbe]]
+
* [[Scripting/SUIText]]
+
* [[Scripting/SUISlider]]
+
* [[Scripting/SUICanvas]]
+
* [[Scripting/SUIButton]]
+
* [[Scripting/SUIDropdown]]
+
* [[Scripting/SUIInputField]]
+
* [[Scripting/SUIScrollbar]]
+
* [[Scripting/SUIToggle]]
+
* [[Scripting/SUIRawImage]]
+
* [[Scripting/SUIImage]]
+
* [[Scripting/STerrain]]
+
* [[Scripting/STrailRenderer]]
+
* [[Scripting/SSkinnedMeshRenderer]]
+
* [[Scripting/SMeshRenderer]]
+
* [[Scripting/SRectTransform]]
+
* [[Scripting/SSceneBackgroundMusic]] (note: may rename to SRadio)
+
* [[Scripting/SSeat]]
+
* [[Scripting/SScriptingRuntime]]
+
* [[Scripting/SScriptingData]]
+
* [[Scripting/ScriptingEvents]]
+
* [[Scripting/SPlayableDirector]]
+
* [[Scripting/SAttachmentHelper]]
+
  
 
==Resources==
 
==Resources==

Revision as of 02:00, 13 July 2021

Client Scripting Function Reference

This API is shared between both C# and Lua runtimes. In case of Lua, we treat 'Nil' as 'null', but otherwise identical. C# scripts are defined as a class inheriting from SpaceScript. Lua scripts have a pre-prepared global named 'Space' containing an instance of the SScript class.

Most of these API designs have been modelled after the API already used by Unity3D to allow existing developers easier familiarity with space.

Full Class List (Automated Documentation): http://space-files.s3.amazonaws.com/docs/client-scripting/annotated.html

Component Classes


Classes

Data Types


Library Classes



Resources

External Events

Server Scripting Function Reference

Coming soon