wiki.sine.space | sinespace

Difference between revisions of "Scripting/Reference"

From wiki.sine.space
Jump to: navigation, search
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
=Client Scripting Function Reference=
 
=Client Scripting Function Reference=
Classes:
+
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/SScript]] (aka 'Space')
 
** [[Scripting/SMath]] Math Functions
 
** [[Scripting/SMath]] Math Functions
Line 16: Line 22:
 
** [[Scripting/SNetwork]] Networking functions (network persisting variables, etc)
 
** [[Scripting/SNetwork]] Networking functions (network persisting variables, etc)
 
** [[Scripting/SPersistence]] Persistence functions (save/retrieve state information permanently, attach to player, scene, global)
 
** [[Scripting/SPersistence]] Persistence functions (save/retrieve state information permanently, attach to player, scene, global)
 +
** [[Scripting/SShared]] IPC functions
  
Library Classes:
+
==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
 +
 
 +
==Library Classes==
 
* [[Scripting/SPostFX]] Post FX control
 
* [[Scripting/SPostFX]] Post FX control
 
* [[Scripting/SDialogues]] Input dialoges/confirmation boxes
 
* [[Scripting/SDialogues]] Input dialoges/confirmation boxes
  
Component Classes:
+
==Component Classes==
 
* [[Scripting/SAnimator]] Access to Animator state machines
 
* [[Scripting/SAnimator]] Access to Animator state machines
 
* [[Scripting/SAudioSource]] Audio Source & Playback
 
* [[Scripting/SAudioSource]] Audio Source & Playback
 
* [[Scripting/SCamera]] Camera controls (e.g. Field of View, Orthographic rendering, etc.)
 
* [[Scripting/SCamera]] Camera controls (e.g. Field of View, Orthographic rendering, etc.)
 +
* [[Scripting/SClickable]] Actions triggered by clicking on the GameObject
 
* [[Scripting/SCollider]]
 
* [[Scripting/SCollider]]
* [[Scripting/SLight]]
+
* [[Scripting/SLight]] Access to the Light properties.
 +
** [[Scripting/SLightType]]
 
* [[Scripting/SNavMeshAgent]]
 
* [[Scripting/SNavMeshAgent]]
 
* [[Scripting/SParticleSystem]]
 
* [[Scripting/SParticleSystem]]
* [[Scripting/SRenderer]]
+
* [[Scripting/SRenderer]] Access to the renderer of an object.
 
* [[Scripting/SRigidbody]]
 
* [[Scripting/SRigidbody]]
 
* [[Scripting/SUIText]]
 
* [[Scripting/SUIText]]
 +
* [[Scripting/STerrain]]
 +
* [[Scripting/SSkinnedMeshRenderer]]
 +
* [[Scripting/SMeshRenderer]]
 +
* [[Scripting/SRectTransform]]
 +
* [[Scripting/SSceneBackgroundMusic]] (note: may rename to SRadio)
 +
* [[Scripting/SSeat]]
  
Resources:
+
==Resources==
 
* [[Scripting/SResource]]
 
* [[Scripting/SResource]]
  
External Events:
+
==External Events==
 
* [[Scripting/Invoking Events]]
 
* [[Scripting/Invoking Events]]
 
* [[Scripting/Calling from UnityEvents]]
 
* [[Scripting/Calling from UnityEvents]]
 +
 +
=Server Scripting Function Reference=
 +
''Coming soon''
  
 
{{Scripting Navbox}}
 
{{Scripting Navbox}}

Revision as of 18:54, 25 July 2017

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

Data Types

Library Classes

Component Classes

Resources

External Events

Server Scripting Function Reference

Coming soon