|
100 | 100 | -- @function pullPhysicsTicks |
101 | 101 | -- @treturn string The event name |
102 | 102 | -- @treturn ... Physics ticks information |
103 | | --- @see physics_ticks_event_data |
| 103 | +-- @see Physics Ticks Event Data |
104 | 104 | -- @raise This method errors if there is no Ship associated with the computer |
105 | 105 |
|
106 | 106 | --- Extended Ship API |
|
234 | 234 |
|
235 | 235 | --- Physics Ticks Event Data |
236 | 236 | -- |
237 | | --- @type physics_ticks_event_data |
| 237 | +-- @type Physics Ticks Event Data |
238 | 238 |
|
239 | 239 | --- Gets the Ship's buoyancy factor during the physics tick |
240 | 240 | -- @function getBuoyancyFactor |
241 | 241 | -- @treturn number The Ship's buoyancy factor |
| 242 | +-- @export |
242 | 243 |
|
243 | 244 | --- Whether the Ship is static during the physics tick |
244 | 245 | -- @function isStatic |
245 | 246 | -- @treturn boolean Whether the Ship is static |
| 247 | +-- @export |
246 | 248 |
|
247 | 249 | --- Whether the Ship is affected by fluid drag during the physics tick |
248 | 250 | -- @function doFluidDrag |
249 | 251 | -- @treturn boolean Whether the Ship has fluid drag |
| 252 | +-- @export |
250 | 253 |
|
251 | 254 | --- Gets the Ship's Inertia Data during the physics tick |
252 | 255 | -- @function getInertiaData |
253 | 256 | -- @treturn table The Ship's Inertia Data comprised of mass and moment of inertia tensor |
| 257 | +-- @export |
254 | 258 |
|
255 | 259 | --- Gets the Ship's Pose and Velocity during the physics tick |
256 | 260 | -- @function getPoseVel |
257 | 261 | -- @treturn table The Ship's Pose and Velocity data including position, rotation, linear velocity, and angular velocity |
| 262 | +-- @export |
258 | 263 |
|
259 | 264 | --- Gets the Force Inducers on the Ship during the physics tick |
260 | 265 | -- @function getForceInducers |
261 | 266 | -- @treturn table A table of Force Inducers on the Ship |
| 267 | +-- @export |
262 | 268 |
|
263 | 269 | if not ship then |
264 | 270 | error("Cannot load Ship API on computer") |
|
0 commit comments