DashboardItemVelocity

Inherits DashboardItem

Members

Name

Documentation

Type

Description

Optional

FontName

This value is the name of the font that is used. It can either refer to an internal name registered previously, or it can refer to a path that is used.

String

Value of type ‘String’

Yes

FontSize

This value determines the size of the font that is used to render the distance.

Double

Value of type ‘Double’

Yes

RequestedUnit

If the simplification is disabled, this distance unit is used for the velocity display.

String

In list { nanometer, micrometer, millimeter, centimeter, decimeter, meter, km, AU, lighthour, lightday, lightmonth, lightyear, parsec, kiloparsec, megaparsec, gigaparsec, gigalightyear, thou, inch, foot, yard, chain, furlong, mile, league }

Yes

Simplification

If this value is enabled, the velocity is displayed in nuanced units, such as m/s, AU/s, light years / s etc. If this value is disabled, the unit can be explicitly requested.

Boolean

Value of type ‘Boolean’

Yes

Asset Examples

 1local Item = {
 2  Type = "DashboardItemVelocity",
 3  Identifier = "CameraVelocity",
 4  Simplification = true,
 5  GuiName = "Camera Velocity"
 6}
 7
 8
 9asset.onInitialize(function()
10  openspace.dashboard.addDashboardItem(Item)
11end)
12
13asset.onDeinitialize(function()
14  openspace.dashboard.removeDashboardItem(Item)
15end)
16
17asset.export(Item)
18
19
20
21asset.meta = {
22  Name = "Dashboard - Velocity",
23  Description = "This asset provides a dashboard item that shows the camera's velocity",
24  Author = "OpenSpace Team",
25  URL = "http://openspaceproject.com",
26  License = "MIT license"
27}