Kryzeth Standard Library

StdLib.Area.Direction

supers: StdLib.Core

Functions for working with directions and orientations.

@usage local Direction = require('kry_stdlib/stdlib/area/direction') --@see defines.direction

Methods11 

function Direction.opposite(direction: defines.direction) -> defines.direction

Returns the opposite direction

Parameters
directiondefines.direction

the direction

Returns
defines.direction

the opposite direction

function Direction.next(direction: defines.direction, eight_way: nil | boolean) -> defines.direction

Returns the next direction.

For entities that only support two directions, see @{opposite}.
Parameters
directiondefines.direction

the starting direction

eight_waynil | boolean

[opt=false] true to get the next direction in 8-way (note: not many prototypes support 8-way)

Returns
defines.direction

the next direction

function Direction.previous(direction: defines.direction, eight_way: nil | boolean) -> the defines.direction

Returns the previous direction.

For entities that only support two directions, see @{opposite}.
Parameters
directiondefines.direction

the starting direction

eight_waynil | boolean

[opt=false] true to get the previous direction in 8-way (note: not many prototypes support 8-way)

Returns
thedefines.direction

next direction

function Direction.to_orientation(direction: defines.direction) -> float

Returns an orientation from a direction.

function Direction.to_vector(direction: defines.direction, distance: nil | number) -> Vector.struct

Returns a vector from a direction.

function Direction.to_vector2(direction: defines.direction, distance: nil | number, round) -> Vector.struct

Returns a vector from a direction.

function Direction.opposite_direction(direction: defines.direction) -> defines.direction
Parameters
directiondefines.direction

the direction

Returns
defines.direction

the opposite direction

function Direction.direction_to_orientation(direction: defines.direction) -> float
 
function Direction.orientation_to_4way(orientation) -> any

Deprecated

function Direction.orientation_to_8way(orientation) -> any
 
function Direction.next_direction(direction, reverse, eight_way) -> -2

Fields18

Direction.__class: string = "Direction"
 
Direction.__index : unknown
 
Direction.north : never

defines.direction.north

Direction.east : never

defines.direction.east

Direction.west : never

defines.direction.west

Direction.south : never

defines.direction.south

Direction.northeast : never

defines.direction.northeast

Direction.northwest : never

defines.direction.northwest

Direction.southeast : never

defines.direction.southeast

Direction.southwest : never

defines.direction.southwest

Direction.northnortheast : never
 
Direction.eastnortheast : never
 
Direction.eastsoutheast : never
 
Direction.southsoutheast : never
 
Direction.southsouthwest : never
 
Direction.westsouthwest : never
 
Direction.westnorthwest : never
 
Direction.northnorthwest : never