|
1 | | ---- Ship API |
2 | | --- |
3 | | --- This API is added by CC: VS and allows CC: Tweaked computers to access information from Valkyrien Skies Ships. |
4 | | --- @module ship_api |
| 1 | +--- This API is added by CC: VS and allows CC: Tweaked computers to access information from Valkyrien Skies Ships. |
| 2 | +-- @module ship |
5 | 3 |
|
6 | 4 | --- Gets the Ship's ID |
7 | 5 | -- @function getId |
|
102 | 100 | -- @function pullPhysicsTicks |
103 | 101 | -- @treturn string The event name |
104 | 102 | -- @treturn ... Physics ticks information |
| 103 | +-- @see physics_ticks_event_data |
105 | 104 | -- @raise This method errors if there is no Ship associated with the computer |
106 | 105 |
|
107 | 106 | --- Physics Ticks Event Data |
108 | 107 | -- |
109 | 108 | -- @section physics_ticks_event_data |
110 | 109 |
|
111 | | ---- This section describes the data returned by the physics ticks event. |
112 | | - |
113 | 110 | --- Gets the Ship's buoyancy factor during the physics tick |
114 | 111 | -- @function getBuoyancyFactor |
115 | 112 | -- @treturn number The Ship's buoyancy factor |
|
138 | 135 | -- |
139 | 136 | -- @section extended_ship_api |
140 | 137 |
|
141 | | ---- This section describes additional methods available in the Ship API for advanced manipulation of the Ship. |
142 | | --- These methods may require special permissions or configurations to use. |
143 | | --- As of CC: VS 0.5.0, these methods are merged into the main Ship API and are available on all computers with Ship access. |
144 | | - |
145 | 138 | --- Sets the Ship to be static or dynamic |
146 | 139 | -- @function setStatic |
147 | 140 | -- @tparam boolean isStatic Whether the Ship should be static |
|
235 | 228 | -- |
236 | 229 | -- @section deprecated |
237 | 230 |
|
238 | | ---- The following methods have been deprecated and are no longer available. |
239 | | --- Please refer to the updated Ship API documentation for alternative methods. |
240 | | - |
241 | 231 | --- Gets the Ship's Euler Angles in ZYX order |
242 | 232 | -- @function getEulerAnglesZYX |
243 | 233 | -- @raise This method no longer exists! Please utilize the new quaternion API! |
|
0 commit comments