Epok Engine

EPOK RUNTIME

epok::NavigationAgent2DComponent

Class

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Class

---- NavigationAgent2D -------------------------------------------------------------------

Namespace
epok
Header
world2d_navigation.hpp
Include
#include "world2d_navigation.hpp"
Module
world2d-navigation
Source
runtime/world2d_navigation.hpp:465
Inherits from
ActorComponent

Basic usage

This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.

C++ example
#include "world2d_navigation.hpp"

epok::NavigationAgent2DComponent& value = /* obtain a valid instance from your game */;

Fields and constants

arrive_distanceExposes `arrive_distance` on `epok::NavigationAgent2DComponent` for the world2d navigation module.FieldarrivedExposes `arrived` on `epok::NavigationAgent2DComponent` for the world2d navigation module.FieldclockExposes `clock` on `epok::NavigationAgent2DComponent` for the world2d navigation module.FielddirtyExposes `dirty` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fielddrives_bodyExposes `drives_body` on `epok::NavigationAgent2DComponent` for the world2d navigation module.FieldfinishedExposes `finished` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldhas_targetExposes `has_target` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldlink2dExposes `link2d` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldmax_speedExposes `max_speed` on `epok::NavigationAgent2DComponent` for the world2d navigation module.FieldpathExposes `path` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldpath_countExposes `path_count` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldpath_indexExposes `path_index` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldplanned_forExposes `planned_for` on `epok::NavigationAgent2DComponent` for the world2d navigation module.FieldreachableExposes `reachable` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldrepath_intervalExposes `repath_interval` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Fieldstatic_class_idExposes `static_class_id` on `epok::NavigationAgent2DComponent` for the world2d navigation module.VariabletargetState.Fieldtarget_actorAuthored.FieldvelocityExposes `velocity` on `epok::NavigationAgent2DComponent` for the world2d navigation module.Field

Public methods

~NavigationAgent2DComponentReleases the resources owned by `epok::NavigationAgent2DComponent`.destructorclass_idPerforms `class id` as part of the world2d navigation module.Methodget_max_speedReturns max speed as part of the world2d navigation module.Methodget_next_xReturns next x as part of the world2d navigation module.Methodget_next_yReturns next y as part of the world2d navigation module.Methodget_path_point_countReturns path point count as part of the world2d navigation module.Methodget_target_actorReturns target actor as part of the world2d navigation module.Methodget_target_xReturns target x as part of the world2d navigation module.Methodget_target_yReturns target y as part of the world2d navigation module.Methodget_velocity_xReturns velocity x as part of the world2d navigation module.Methodget_velocity_yReturns velocity y as part of the world2d navigation module.Methodis_navigation_finishedReports whether navigation finished as part of the world2d navigation module.Methodis_target_reachableReports whether target reachable as part of the world2d navigation module.Methodlevel_attachedPerforms `level attached` as part of the world2d navigation module.Methodset_max_speedSets max speed as part of the world2d navigation module.Methodset_target_actorSets target actor as part of the world2d navigation module.Methodset_target_positionSets target position as part of the world2d navigation module.MethodstopStops following: no target, no path, no velocity.Methodtake_arrivedTrue once when the agent reaches a reachable target.Method