Class: openspace

Methods

---

init()

Function to initial mouse control related (robotjs) variable

Properties:

Name	Type	Description
mouse	array-number	The user's mouse x and y position
altY	array-number	How many y pixels should mouse increase/decrease while holding right key (zoom in/zoom out)
latY	array-number	How many y pixels should mouse increase/decrease while holding left key (rotate up/rotate down)
latX	array-number	How many x pixels should mouse increase/decrease while holding left key (rotate left/rotate right)

Source:

• openspace.js, line 41

---

clear(type)

Function to clear mouse control

Parameters:

Name	Type	Description
type	string	'alt' / 'lat' / 'all'

Source:

• openspace.js, line 54

---

moveAltitude(type, value)

Function to move altitude (zoom in or zoom out)

Parameters:

Name	Type	Description
type	string	1 (zoom out) / 1 (zoom in)
value	string	How many pixels should be moved

Source:

• openspace.js, line 87

---

moveGeo(msg)

Function to move latitude and longitude (rotation)

Parameters:

Name	Type	Description
msg	array-number	A array includes {angle,distance}

Properties:

Name	Type	Description
msg.angle	object	What is angle triggered on joystick.
msg.distance	library	What is distance triggered on joystick.

Source:

• openspace.js, line 121

---

screenshot(setting)

Function to screenshot OpenSpace, then send the screenshot to client's device

Parameters:

Name	Type	Description
setting	object	The configuration object

Source:

• openspace.js, line 208

---

changePlanet(planet)

Function to change OpenSpace current focus planet

Parameters:

Name	Type	Description
planet	string	The number of planet

Source:

• openspace.js, line 278

---

trigger(event)

Function to trigger the api script

Parameters:

Name	Type	Description
event	object	The api event

Source:

• openspace.js, line 290

---

set(event)

Function to set the api value

Parameters:

Name	Type	Description
event	object	The api event

Source:

• openspace.js, line 308

---

lua(script)

Function to run lua script

Parameters:

Name	Type	Description
script	object	The lua script

Source:

• openspace.js, line 326