overmap vessel
Overmap ships
Basically, any overmap object that is capable of moving by itself.
Vars | |
| base_icon_state | Prefix of all the icons used by the ship. ([base_icon_state]_moving and [base_icon_state]_damaged) |
|---|---|
| max_speed | Max possible speed (1 tile per second) |
| min_speed | Minimum speed. Any lower is rounded down. (0.5 tiles per minute) |
| movement_callback_id | Timer ID of the looping movement timer |
| speed | The current speed in x/y direction in grid squares per minute |
Procs | |
| accelerate | Change the speed in a specified dir. |
| adjust_speed | Change the speed in any direction. |
| decelerate | Reduce the speed or stop in all directions. |
| get_eta | Returns the estimated time in deciseconds to the next tile at current speed |
| get_heading | Returns the direction the ship is moving in terms of dirs |
| get_speed | Returns the total speed in all directions. |
| handle_wraparound | Check if the ship is flying into the border of the overmap. |
| is_still | Returns whether or not the ship is moving in any direction. |
| tick_move | Called by /proc/adjust_speed(), this continually moves the ship according to it's speed |
Var Details
base_icon_state
Prefix of all the icons used by the ship. ([base_icon_state]_moving and [base_icon_state]_damaged)
max_speed
Max possible speed (1 tile per second)
min_speed
Minimum speed. Any lower is rounded down. (0.5 tiles per minute)
movement_callback_id
Timer ID of the looping movement timer
speed
The current speed in x/y direction in grid squares per minute
Proc Details
accelerate
Change the speed in a specified dir.
- direction - dir to accelerate in (NORTH, SOUTH, SOUTHEAST, etc.)
- acceleration - How much to accelerate by
adjust_speed
Change the speed in any direction.
- n_x - Speed in the X direction to change
- n_y - Speed in the Y direction to change
decelerate
Reduce the speed or stop in all directions.
- acceleration - How much to decelerate by
get_eta
Returns the estimated time in deciseconds to the next tile at current speed
get_heading
Returns the direction the ship is moving in terms of dirs
get_speed
Returns the total speed in all directions.
The equation for speed is as follows: 60 SECONDS / (1 / ([ship's speed] / ([ship's mass] * 100)))
handle_wraparound
Check if the ship is flying into the border of the overmap.
is_still
Returns whether or not the ship is moving in any direction.
tick_move
Called by /proc/adjust_speed(), this continually moves the ship according to it's speed