Sinespace Client
2023.2.17543
Client-side scripting for Sinespace
|
Public Member Functions | |
override void | Initialise (SScript runtime, object wrapper) |
void | LockCamera (SGameObject owner) |
Takes control of the Camera as long as 'owner' exists in the scene, or until ReleaseCamera() has been called. More... | |
void | ReleaseCamera () |
Relinquishes control of the Camera back to Space More... | |
void | SetCameraPositionOrientation (SVector position, SQuaternion orientation) |
Forces the camera to be at position facing orientation for the frame. Needs to be called every frame. More... | |
SRay | ScreenCoordinatesToRay (SVector screenCoordinates) |
Returns a ray going from camera through a screen point. More... | |
SVector | ScreenCoordinatesToWorld (SVector screenCoordinates) |
Transforms a point from screen space into world space More... | |
SVector | WorldCoordinatesToScreen (SVector coordinates) |
Transforms position from world space into screen space. More... | |
void | ShakeCamera (float magnitude, float time) |
void | ShakeCamera (float amplitude, float frequency, float time) |
Public Member Functions inherited from ScriptClass< T > | |
void | ReportError (string error, bool fatal, UnityEngine.Object target=null) |
Public Member Functions inherited from ScriptClassWrapper< T > | |
override void | Initialise (SScript runtime, object wrapper) |
Properties | |
bool | IsLocked [get] |
Returns true if the Camera is locked More... | |
SGameObject | MainCamera [get] |
Note, this property is generally read-only. It's position is driven by internal code. Will return null if main camera is not yet initialized. More... | |
SGameObject | ActiveVirtualCamera [get] |
Get the currently active Cinemachine Virtual Camera game object. More... | |
Properties inherited from ScriptClass< T > | |
override bool | Alive [get] |
Return if the component is alive. More... | |
virtual bool | Alive [get] |
DynValue | CachedData [get, set] |
Properties inherited from ScriptClassWrapper< T > | |
T | _wrap [get] |
Additional Inherited Members | |
Protected Member Functions inherited from ScriptClass< T > | |
void | Initialise (SScript runtime) |
|
virtual |
Implements ScriptClass< T >.
void SineSpace.Scripting.Scene.SCameraManager.LockCamera | ( | SGameObject | owner | ) |
Takes control of the Camera as long as 'owner' exists in the scene, or until ReleaseCamera() has been called.
void SineSpace.Scripting.Scene.SCameraManager.ReleaseCamera | ( | ) |
Relinquishes control of the Camera back to Space
Returns a ray going from camera through a screen point.
screenCoordinates | Screen Corrdinates(Use screen size percent range(0,1)) |
SVector SineSpace.Scripting.Scene.SCameraManager.ScreenCoordinatesToWorld | ( | SVector | screenCoordinates | ) |
Transforms a point from screen space into world space
screenCoordinates | Screen Corrdinates(Use screen size percent range(0,1) |
–Vector3 the worldspace point created by converting the screen space point at the provided distance z from the camera plane.
void SineSpace.Scripting.Scene.SCameraManager.SetCameraPositionOrientation | ( | SVector | position, |
SQuaternion | orientation | ||
) |
Forces the camera to be at position facing orientation for the frame. Needs to be called every frame.
position | Camera Position |
orientation | Camera Rotation |
void SineSpace.Scripting.Scene.SCameraManager.ShakeCamera | ( | float | amplitude, |
float | frequency, | ||
float | time | ||
) |
void SineSpace.Scripting.Scene.SCameraManager.ShakeCamera | ( | float | magnitude, |
float | time | ||
) |
Transforms position from world space into screen space.
coordinates | World space position |
|
get |
Get the currently active Cinemachine Virtual Camera game object.
< /example>
|
get |
Returns true if the Camera is locked
|
get |
Note, this property is generally read-only. It's position is driven by internal code. Will return null if main camera is not yet initialized.