UE3:NavigationPoint (UDK)

Object >> Actor >> NavigationPoint

Package: 

Engine

Direct subclasses:

CoverLink, CoverSlotMarker, DoorMarker, DynamicAnchor, Ladder, LiftCenter, LiftExit, MantleMarker, Objective, PathNode, PickupFactory, PlayerStart, PortalMarker, Pylon, Teleporter, TriggeredPath, UTDefensePoint, UTJumpPad, UTVehicleFactory

This class in other games:

RTNP, U1, UT, U2, U2XMP, UT2003, UE2Runtime, UT2004, UT3

NavigationPoint.

NavigationPoints are organized into a network to provide AIControllers the capability of determining paths to arbitrary destinations in a level

Constants

INFINITE_PATH_COST

Value: 10000000

Properties

Property group 'NavigationPoint'

bBlocked

Type: bool

this node is currently unuseable

bMakeSourceOnly

Type: bool

bOneWayPath

Type: bool

reachspecs from this path only in the direction the path is facing (180 degrees)

bVehicleDestination

Type: bool

if true, forced paths to this node will have max width to accomodate vehicles

ExtraCost

Type: int

Extra weight added by level designer

MaxPathSize

Type: Object.Cylinder

Modifiers: editconst, const

path size of the largest ReachSpec in this node's PathList

NavGuid

Type: Object.Guid

Modifiers: editconst, const, duplicatetransient

GUID used for linking paths across levels

NetworkID

Type: int

Modifiers: editconst, const

Which navigation network does this navigation point connect to?

Default value: -1

PathList

Type: array<ReachSpec>

Modifiers: editinline, const, editconst, duplicatetransient

index of reachspecs (used by C++ Navigation code)

Volumes

Type: array<Actor.ActorReference>

Modifiers: const, editconst

List of volumes containing this navigation point relevant for gameplay

Property group 'VehicleUsage'

bBlockedForVehicles

Type: bool

indicates vehicles cannot use this node

bPreferredVehiclePath

Type: bool

vehicles with bUsePreferredVehiclePaths set (large vehicles, usually) will prioritize using these nodes

Internal variables

See NavigationPoint internal variables.

Default values

Property	Value
bCollideWhenPlacing	True
bForceAllowKismetModification	True
bNoDelete	True
bStatic	True
CollisionComponent	CylinderComponent'CollisionCylinder'
CollisionType	COLLIDE_CustomDefault
Components[0]	SpriteComponent'Sprite'
Components[1]	SpriteComponent'Sprite2'
Components[2]	ArrowComponent'Arrow'
Components[3]	CylinderComponent'CollisionCylinder'
Components[4]	PathRenderingComponent'PathRenderer'

Subobjects

Arrow

Class: Engine.ArrowComponent

Property	Value
ArrowColor	Member Value A 255 B 255 G 200 R 150
ArrowSize	0.5
bTreatAsASprite	True
ReplacementPrimitive	None

CollisionCylinder

Class: Engine.CylinderComponent

Property	Value
CollisionHeight	50.0
CollisionRadius	50.0
ReplacementPrimitive	None

PathRenderer

Class: Engine.PathRenderingComponent

Property	Value
ReplacementPrimitive	None

Sprite

Class: Engine.SpriteComponent

Property	Value
AlwaysLoadOnClient	False
AlwaysLoadOnServer	False
HiddenGame	True
ReplacementPrimitive	None
Sprite	Texture2D'EditorResources.S_NavP'

Sprite2

Class: Engine.SpriteComponent

Property	Value
AlwaysLoadOnClient	False
AlwaysLoadOnServer	False
HiddenEditor	True
HiddenGame	True
ReplacementPrimitive	None
Scale	0.25
Sprite	Texture2D'EditorResources.Bad'

Structs

CheckpointRecord

bool bDisabled 

bool bBlocked 

DebugNavCost

Modifiers: native

Mapping of Cost/Description for costs of this node

string Desc 

int Cost 

NavigationOctreeObject

Modifiers: native

structure for inserting things into the navigation octree

Object.Box BoundingBox 

the bounding box to use

Object.Vector BoxCenter 

cached center of that box

pointer{class FNavigationOctreeNode} OctreeNode 

if this object is in the octree, pointer to the node it's in, otherwise NULL

Object Owner 

UObject that owns the entry in the octree

byte OwnerType 

bitfield representing common classes of Owner so we can avoid casts

Functions

Static native functions

GetAllNavInRadius

static native final function bool GetAllNavInRadius (Actor ChkActor, Object.Vector ChkPoint, float Radius, out array<NavigationPoint> out_NavList, optional bool bSkipBlocked, optional int inNetworkID, optional Object.Cylinder MinSize)

Returns all navigation points near the ChkPoint specified by Radius.

Other static functions

GetNearestNavToActor

static final function NavigationPoint GetNearestNavToActor (Actor ChkActor, optional class<NavigationPoint> RequiredClass, optional array<NavigationPoint> ExcludeList, optional float MinDist)

Returns the nearest valid navigation point to the given actor.

GetNearestNavToPoint

static final function NavigationPoint GetNearestNavToPoint (Actor ChkActor, Object.Vector ChkPoint, optional class<NavigationPoint> RequiredClass, optional array<NavigationPoint> ExcludeList)

Returns the nearest valid navigation point to the given point.

Native functions

CanTeleport

native function bool CanTeleport (Actor A)

returns whether this NavigationPoint is a teleporter that can teleport the given Actor

GetBoundingCylinder

native function GetBoundingCylinder (out float CollisionRadius, out float CollisionHeight) const

Overrides: Actor.GetBoundingCylinder

GetReachSpecTo

native final function ReachSpec GetReachSpecTo (NavigationPoint Nav, optional class<ReachSpec> SpecClass)

IsOnDifferentNetwork

native final function bool IsOnDifferentNetwork (NavigationPoint Nav)

Returns if this navigation point is on a different network than the given

IsUsableAnchorFor

native function bool IsUsableAnchorFor (Pawn P)

returns whether this NavigationPoint is valid to be considered as an Anchor (start or end) for pathfinding by the given Pawn

Parameters:

• P - the Pawn doing pathfinding

Returns:

whether or not we can be an anchor

Events

Accept

event bool Accept (Actor Incoming, Actor Source)

DetourWeight

event float DetourWeight (Pawn Other, float PathWeight)

GetDebugAbbrev

simulated event string GetDebugAbbrev ()

Returns:

Debug abbrev for hud printing

ShutDown

simulated event ShutDown ()

Overrides: Actor.ShutDown

ShutDown an actor.

SpecialCost

event int SpecialCost (Pawn Seeker, ReachSpec Path)

SuggestMovePreparation

event bool SuggestMovePreparation (Pawn Other)

Other instance functions

ApplyCheckpointRecord

function ApplyCheckpointRecord (const out CheckpointRecord Record)

CreateCheckpointRecord

function CreateCheckpointRecord (out CheckpointRecord Record)

OnToggle

function OnToggle (SeqAct_Toggle inAction)

Toggle the blocked state of a navigation point.

ProceedWithMove

function bool ProceedWithMove (Pawn Other)

ShouldSaveForCheckpoint

function bool ShouldSaveForCheckpoint ()