wiki.sine.space | sinespace

Difference between revisions of "Scripting/Reference"

From wiki.sine.space
Jump to: navigation, search
m
m
Line 124: Line 124:
  
 
==Types Classes==
 
==Types Classes==
* string, byte, int long, float, double, char, etc.
 
  
* [[Scripting/SAnimationState]]  
+
* [[Scripting/SAnimationState]]
 
* [[Scripting/SAnimatorStateInfo]]
 
* [[Scripting/SAnimatorStateInfo]]
 
* [[Scripting/SAvatar]]
 
* [[Scripting/SAvatar]]
Line 136: Line 135:
 
* [[Scripting/SGameObject]]
 
* [[Scripting/SGameObject]]
 
* [[Scripting/SGroupInfo]]
 
* [[Scripting/SGroupInfo]]
 +
* [[Scripting/SJointLimits]]
 +
* [[Scripting/SJointMotor]]
 +
* [[Scripting/SJointSpring]]
 
* [[Scripting/SLandmark]]
 
* [[Scripting/SLandmark]]
* [[Scripting/SLayerMask]] A way to filter physics hits
+
* [[Scripting/SLayerMask]]
* [[Scripting/SMaterial]] A reference to a rendering material
+
* [[Scripting/SMaterial]]
 
* [[Scripting/SParticle]]
 
* [[Scripting/SParticle]]
 +
* [[Scripting/SPhysicsHit]]
 
* [[Scripting/SPublicRegion]]
 
* [[Scripting/SPublicRegion]]
* [[Scripting/SQuaternion]] A Quaternion used for storing proper rotational information
+
* [[Scripting/SQuaternion]]
 
* [[Scripting/SRay]]
 
* [[Scripting/SRay]]
 
* [[Scripting/SRect]]
 
* [[Scripting/SRect]]
Line 150: Line 153:
 
* [[Scripting/SUIRaycastResult]]
 
* [[Scripting/SUIRaycastResult]]
 
* [[Scripting/SUserRegions]]
 
* [[Scripting/SUserRegions]]
* [[Scripting/SVector]] A 3D Vector class for storing positions/euler rotations
+
* [[Scripting/SVector]]
* [[Scripting/STrackInfo]] Stores Track Info on Radio track changes
+
  
  
==Network Classes==
 
* [[Scripting/SNetworkMessage]] A network message received from another script
 
* [[Scripting/SWebResponse]] Stores the response from a Web Request
 
  
==Scene Classes==
 
* [[Scripting/SPhysicsHit]] Stores hits occurring in the physics subsystems (e.g. Raycast Hits, Collider Hits, etc)
 
 
==Classes==
 
* [[Scripting/SScript]] (aka 'Space')
 
** [[Scripting/SMath]] Math Functions
 
** [[Scripting/SScene]] Scene Functions
 
*** [[Scripting/SGameObject]] Game Objects
 
*** [[Scripting/SGames]] Games Functions
 
*** [[Scripting/SAvatar]] Avatars/Players
 
*** [[Scripting/SAvatarAppearence]] Avatars/Appearence
 
** [[Scripting/SInventory]] Inventory access
 
*** [[Scripting/SInventoryItem]] Inventory items
 
** [[Scripting/SUserProfile]] User Profile access
 
** [[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/SChat]]
 
** [[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/SGroupInfo]] GroupInfo functions
 
** [[Scripting/SQuests]] Quest functions  (already on Doxygen)
 
** [[Scripting/SColor]] Color functions
 
** [[Scripting/SAXParameter]] AXParameter class
 
** [[Scripting/SRenderSettings]] Render settings
 
** [[Scripting/SRay]]
 
** [[Scripting/SCommandBuffer]]Graphics commands.
 
** [[Scripting/SScoreRank]]ScoreRank functions.
 
 
 
==External Events==
 
* [[Scripting/Invoking Events]]
 
* [[Scripting/Calling from UnityEvents]]
 
  
 
=Server Scripting Function Reference=
 
=Server Scripting Function Reference=

Revision as of 05:29, 23 August 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

Client


Component

Library

Network

Player

RenderSettings

Scene

Types Classes



Server Scripting Function Reference

Coming soon