|
103 | 103 | -- @see physics_ticks_event_data |
104 | 104 | -- @raise This method errors if there is no Ship associated with the computer |
105 | 105 |
|
106 | | ---- Physics Ticks Event Data |
107 | | --- |
108 | | --- @section physics_ticks_event_data |
109 | | - |
110 | | ---- Gets the Ship's buoyancy factor during the physics tick |
111 | | --- @function getBuoyancyFactor |
112 | | --- @treturn number The Ship's buoyancy factor |
113 | | - |
114 | | ---- Whether the Ship is static during the physics tick |
115 | | --- @function isStatic |
116 | | --- @treturn boolean Whether the Ship is static |
117 | | - |
118 | | ---- Whether the Ship is affected by fluid drag during the physics tick |
119 | | --- @function doFluidDrag |
120 | | --- @treturn boolean Whether the Ship has fluid drag |
121 | | - |
122 | | ---- Gets the Ship's Inertia Data during the physics tick |
123 | | --- @function getInertiaData |
124 | | --- @treturn table The Ship's Inertia Data comprised of mass and moment of inertia tensor |
125 | | - |
126 | | ---- Gets the Ship's Pose and Velocity during the physics tick |
127 | | --- @function getPoseVel |
128 | | --- @treturn table The Ship's Pose and Velocity data including position, rotation, linear velocity, and angular velocity |
129 | | - |
130 | | ---- Gets the Force Inducers on the Ship during the physics tick |
131 | | --- @function getForceInducers |
132 | | --- @treturn table A table of Force Inducers on the Ship |
133 | | - |
134 | 106 | --- Extended Ship API |
135 | 107 | -- |
136 | 108 | -- @section extended_ship_api |
|
155 | 127 | -- Use with caution. |
156 | 128 | -- |
157 | 129 | -- @function teleport |
158 | | --- @tparam table The new position and orientation for the Ship |
| 130 | +-- @tparam table data The new position and orientation for the Ship |
159 | 131 | -- @raise This method errors if there is no Ship associated with the computer OR if the computer is not a Command Computer and the configuration disallows it OR if this method is disabled in the configuration. |
160 | 132 |
|
161 | 133 | --- Applies an invariant force to the Ship |
|
260 | 232 | -- @function getRotationMatrix |
261 | 233 | -- @raise This method no longer exists! Use getTransformationMatrix instead! |
262 | 234 |
|
| 235 | +--- Physics Ticks Event Data |
| 236 | +-- |
| 237 | +-- @type physics_ticks_event_data |
| 238 | + |
| 239 | +--- Gets the Ship's buoyancy factor during the physics tick |
| 240 | +-- @function getBuoyancyFactor |
| 241 | +-- @treturn number The Ship's buoyancy factor |
| 242 | + |
| 243 | +--- Whether the Ship is static during the physics tick |
| 244 | +-- @function isStatic |
| 245 | +-- @treturn boolean Whether the Ship is static |
| 246 | + |
| 247 | +--- Whether the Ship is affected by fluid drag during the physics tick |
| 248 | +-- @function doFluidDrag |
| 249 | +-- @treturn boolean Whether the Ship has fluid drag |
| 250 | + |
| 251 | +--- Gets the Ship's Inertia Data during the physics tick |
| 252 | +-- @function getInertiaData |
| 253 | +-- @treturn table The Ship's Inertia Data comprised of mass and moment of inertia tensor |
| 254 | + |
| 255 | +--- Gets the Ship's Pose and Velocity during the physics tick |
| 256 | +-- @function getPoseVel |
| 257 | +-- @treturn table The Ship's Pose and Velocity data including position, rotation, linear velocity, and angular velocity |
| 258 | + |
| 259 | +--- Gets the Force Inducers on the Ship during the physics tick |
| 260 | +-- @function getForceInducers |
| 261 | +-- @treturn table A table of Force Inducers on the Ship |
| 262 | + |
263 | 263 | if not ship then |
264 | 264 | error("Cannot load Ship API on computer") |
265 | 265 | end |
|
0 commit comments