| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/NavigationSystem/Public/NavLinkCustomComponent.h |
Include |
#include "NavLinkCustomComponent.h" |
class UNavLinkCustomComponent :
public UNavRelevantComponent,
public INavLinkCustomInterface
Encapsulates NavLinkCustomInterface interface, can be used with Actors not relevant for navigation
Additional functionality:
can be toggled
can create obstacle area for easier/forced separation of link end points
can broadcast state changes to nearby agents
Name | Description | ||
---|---|---|---|
|
uint32: 1 |
bCreateBoxObstacle |
If set, box obstacle area will be added to generation |
|
uint32: 1 |
bLinkEnabled |
Is link currently in enabled state? (area class) |
|
uint32: 1 |
bNotifyWhenDisabled |
Should link notify nearby agents when it changes state to disabled |
|
uint32: 1 |
bNotifyWhenEnabled |
Should link notify nearby agents when it changes state to enabled |
|
TEnumAsByte< EC... |
BroadcastChannel |
Trace channel for state change broadcast |
|
float |
BroadcastInterval |
Interval for state change broadcast (0 = single broadcast) |
|
float |
BroadcastRadius |
Radius of state change broadcast |
|
TSubclassOf< UN... |
DisabledAreaClass |
Area class to use when link is disabled |
|
TSubclassOf< UN... |
EnabledAreaClass |
Area class to use when link is enabled |
|
TEnumAsByte< EN... |
LinkDirection |
Direction of link |
|
LinkRelativeEnd |
End point, relative to owner |
|
|
LinkRelativeStart |
Start point, relative to owner |
|
|
MovingAgents |
List of agents moving though this link |
|
|
NavLinkUserId |
Link Id assigned by navigation system |
|
|
TSubclassOf< UN... |
ObstacleAreaClass |
Area class for simple box obstacle |
|
ObstacleExtent |
Extent of simple box obstacle |
|
|
ObstacleOffset |
Offset of simple box obstacle |
|
|
OnBroadcastFilter |
Delegate to call when link is reached |
|
|
OnMoveReachedLink |
Delegate to call when link is reached |
|
|
SupportedAgents |
Restrict area only to specified agents |
|
|
TimerHandle_BroadcastStateChange |
Handle for efficient management of BroadcastStateChange timer |
Name | Description | |
---|---|---|
|
UNavLinkCustomComponent ( |
Name | Description | ||
---|---|---|---|
|
AddNavigationObstacle ( |
Add box obstacle during generation of navigation data this can be used to create empty area under doors |
|
|
ApplyComponentInstanceData ( |
||
|
BroadcastStateChange() |
Notify nearby agents about link changing state |
|
|
ClearNavigationObstacle() |
Removes simple obstacle |
|
|
CollectNearbyAgents |
Gather agents to notify about state change |
|
|
TSubclassOf<... |
GetDisabledArea() |
|
|
TSubclassOf<... |
GetEnabledArea() |
|
|
GetEndPoint() |
Get link end point in world space |
|
|
FNavigationL... |
GetLinkModifier() |
|
|
GetStartPoint() |
Get link start point in world space |
|
|
FNavAgentSel... |
GetSupportedAgents() |
|
|
HasMovingAgents() |
Check is any agent is currently moving though this link |
|
|
IsEnabled() |
||
|
SendBroadcastWhenDisabled ( |
||
|
SendBroadcastWhenEnabled ( |
||
|
SetBroadcastData ( |
Set properties of trigger around link entry point(s), that will notify nearby agents about link state change |
|
|
SetBroadcastFilter ( |
||
|
SetBroadcastFilter ( |
||
|
SetBroadcastFilter ( |
Set delegate to filter |
|
|
SetDisabledArea ( |
Set area class to use when link is disabled |
|
|
SetEnabled ( |
Change state of smart link (used area class) |
|
|
SetEnabledArea ( |
Set area class to use when link is enabled |
|
|
SetLinkData ( |
Set basic link data: end points and direction |
|
|
SetMoveReachedLink ( |
Set delegate to notify about reaching this link during path following |
|
|
SetMoveReachedLink ( |
||
|
SetMoveReachedLink ( |
||
|
SetSupportedAgents ( |
Name | Description | ||
---|---|---|---|
|
CalcAndCacheBounds() |
Name | Description | ||
---|---|---|---|
|
TStructOnSco... |
GetComponentInstanceData() |
Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation |
|
OnRegister() |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
|
|
OnUnregister() |
Called when a component is unregistered. |
Name | Description | ||
---|---|---|---|
|
PostEditImport() |
Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
Name | Description | ||
---|---|---|---|
|
GetNavigationData ( |
Prepare navigation modifiers |
Name | Description | ||
---|---|---|---|
|
TSubclassOf<... |
GetLinkAreaClass() |
Get basic link data: area class (null = default walkable) |
|
GetLinkData ( |
Get basic link data: two points (relative to owner) and direction |
|
|
GetLinkId() |
Get unique ID number for custom link Owner should get its unique ID by calling INavLinkCustomInterface::GetUniqueId() and store it |
|
|
GetSupportedAgents ( |
Get agents supported by this link |
|
|
IsLinkPathfindingAllowed ( |
Check if link allows path finding Querier is usually an AIController trying to find path |
|
|
OnLinkMoveFinished ( |
Notify called when agent finishes using this link for movement |
|
|
OnLinkMoveStarted |
Notify called when agent starts using this link for movement. |
|
|
UpdateLinkId ( |
Update unique ID number for custom link by navigation system |
Name |
Description |
---|---|
FBroadcastFilter |
|
FOnMoveReachedLink |