Scripting/Reference

Note: Scripting is arriving in Editor Pack 9, due for release on January 25th

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.

Classes

• Scripting/SScript (aka 'Space')
  • Scripting/SMath Math Functions
  • Scripting/SScene Scene Functions
    • Scripting/SGameObject Game Objects
    • Scripting/SAvatar Avatars/Players
  • Scripting/SInventory Inventory access
    • Scripting/SInventoryItem Inventory items
  • Scripting/SHost Scripting Runtime
  • 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/SPersistence Persistence functions (save/retrieve state information permanently, attach to player, scene, global)

Data Types

• Scripting/SVector A 3D Vector class for storing positions/euler rotations
• Scripting/SQuaternion A Quaternion used for storing proper rotational information

Library Classes

• Scripting/SPostFX Post FX control
• Scripting/SDialogues Input dialoges/confirmation boxes

Component Classes

• Scripting/SAnimator Access to Animator state machines
• Scripting/SAudioSource Audio Source & Playback
• Scripting/SCamera Camera controls (e.g. Field of View, Orthographic rendering, etc.)
• Scripting/SCollider
• Scripting/SLight
• Scripting/SNavMeshAgent
• Scripting/SParticleSystem
• Scripting/SRenderer
• Scripting/SRigidbody
• Scripting/SUIText

Resources

• Scripting/SResource

External Events

• Scripting/Invoking Events
• Scripting/Calling from UnityEvents

Server Scripting Function Reference

Coming soon