space-engineers-api/spaceEngineers.navigation

Package spaceEngineers.navigation

Types

CharacterNavigation

class CharacterNavigation( val spaceEngineers: SpaceEngineers, val pathFinder: PathFinder<BlockId, Vec3F, String, String>, val movement: CharacterMovement = VectorMovement(spaceEngineers)) : Navigation

typealias Edge = DataEdge<String, NodeId, String>

JavaFriendlyNavigation

class JavaFriendlyNavigation constructor(val navigation: Navigation, val scope: CoroutineScope = GlobalScope)

@Serializable

data class NavGraph(val nodes: List<Node> = emptyList(), val edges: List<Edge> = emptyList())

interface Navigation

typealias Node = DataNode<NodeId, Vec3F>

typealias NodeId = BlockId

interface PathFinder<NodeId, NodeData, EdgeId, EdgeData>

class RichNavGraph(val navGraph: NavGraph = NavGraph())

ScreenNavigation

class ScreenNavigation( val spaceEngineers: SpaceEngineers, transitions: List<ScreenTransition> = DEFAULT_TRANSITIONS, search: GraphSearch<ScreenName, String> = BasicGraphSearch(transitions.toGraph().toExtra()))

ScreenTransition

data class ScreenTransition( val from: ScreenName, val to: ScreenName, val timeout: Duration = 15.seconds, val transition: ScreenTransitionAction)

ScreenTransitionAction

typealias ScreenTransitionAction = suspend ScreenTransition.ScreenTransitionContext.() -> Unit

Functions

infix fun ScreenName.edgeTo(to: ScreenName): String

fun Edge.isConnectedTo(id: NodeId): Boolean

fun makeEdgeId(from: Any, to: Any): String

fun Edge.otherEnd(id: NodeId): NodeId

fun ScreenTransition.toDirectedEdge(): DataEdge<String, ScreenName, ScreenTransition>

fun List<ScreenTransition>.toGraph(): DirectedGraph<ScreenName, Unit, String, ScreenTransition>

fun ScreenName.toNode(): Node<ScreenName, Unit>

fun NavGraph.toRichGraph(): RichNavGraph

Properties

DEFAULT_TRANSITIONS

val DEFAULT_TRANSITIONS: List<ScreenTransition>