Revision as of 07:34, 31 December 2020

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

Classes

• Scripting/SScript (aka 'Space')
  • Scripting/SMath Math Functions
  • Scripting/SScene Scene Functions
    • Scripting/SGameObject Game Objects
    • Scripting/SAvatar Avatars/Players
    • Scripting/SAvatarAppearence Avatars/Appearence
  • Scripting/SInventory Inventory access
    • Scripting/SInventoryItem Inventory items
  • Scripting/SFurniture Furniture items
  • Scripting/SHost Scripting runtime
  • Scripting/ScriptClass
  • Scripting/SPhysics Physics (see also Scripting/SRigidbody)
  • Scripting/SString String functions
  • Scripting/SInput Input functions
  • Scripting/SCameraManager Camera manipulation (see also Scripting/SPostFX, Scripting/SCamera)
  • Scripting/SWebService HTTP Requests & Web Services
  • Scripting/SNetwork Networking functions (network persisting variables, etc)
  • Scripting/SChatMessage
  • Scripting/SPersistence Persistence functions (save/retrieve state information permanently to player)
  • Scripting/SShared IPC functions
  • Scripting/SEconomy Economy functions
  • Scripting/SGroup Group functions
  • Scripting/SQuests Quest functions
  • Scripting/SColor Color functions
  • Scripting/SAXParameter AXParameter class
  • Scripting/SRenderSettings Render settings
  • Scripting/SCommandBufferGraphics commands.

Data Types

• string, byte, int long, float, double, char, etc.
• Scripting/SVector A 3D Vector class for storing positions/euler rotations
• Scripting/SQuaternion A Quaternion used for storing proper rotational information
• Scripting/SPhysicsHit Stores hits occurring in the physics subsystems (e.g. Raycast Hits, Collider Hits, etc)
• Scripting/SWebResponse Stores the response from a Web Request
• Scripting/SNetworkMessage A network message received from another script
• Scripting/SMaterial A reference to a rendering material
• Scripting/SLayerMask A way to filter physics hits
• Scripting/STrackInfo Stores Track Info on Radio track changes

Library Classes

• Scripting/SPostFX Post FX control
• 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/SBrowserSurface Turn a surface into a browser
• Scripting/SCamera Camera controls (e.g. Field of View, Orthographic rendering, etc.)
• Scripting/SClickable Actions triggered by clicking on the GameObject
• Scripting/SCollider
• Scripting/SphereCollider
• Scripting/SLight Access to the Light properties.
  • Scripting/SLightType
• Scripting/SNavMeshAgent
• Scripting/SNavMeshObstacle
• Scripting/SParticleSystem
• 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

Resources

• Scripting/SResource

External Events

• Scripting/Invoking Events
• Scripting/Calling from UnityEvents

Server Scripting Function Reference

Coming soon