PathBerserker2d  1.0
Platformer pathfinding solution
Static Public Member Functions | Static Public Attributes | Properties | List of all members
PathBerserker2d.PathBerserker2dSettings Class Reference

Contains all project wide settings for PathBerserker2d. More...

Inheritance diagram for PathBerserker2d.PathBerserker2dSettings:

Static Public Member Functions

static string GetLinkTypeName (int linkType)
 Get the human readable name of a specific link type. More...
 
static Color GetLinkTypeColor (int linkType)
 Get color associated with specific link type. More...
 
static Color GetNavTagColor (int navTag)
 Get the assigned color of a specific NavTag. More...
 
static int EnsureNavTagExists (int navTag)
 If the NavTag does not exists, returns 0 More...
 
static int EnsureNavLinkTypeExists (int linkType)
 If the linkType does not exists, returns 0 More...
 

Static Public Attributes

const string GlobalSettingsFolder = "Assets/PathBerserker2d/Resources"
 
const string GlobalSettingsFile = "PathBerserker2dSettings"
 

Properties

static bool DrawUnselectedLinks [get]
 Should unselected links be drawn? Only relevant when not in play mode. More...
 
static string[] NavLinkTypeNames [get]
 Array of all link type names More...
 
static Color[] NavLinkTypeColors [get]
 Array of all NavTag colors More...
 
static string[] NavTags [get]
 Array of all NavTag names More...
 
static Color[] NavTagColors [get]
 Array of all NavTag colors More...
 
static bool DrawUnselectedSurfaces [get]
 Should unselected surfaces be drawn? Only relevant when not in play mode. More...
 
static bool DrawUnselectedSubstractors [get]
 Should unselected substractors be drawn? Only relevant when not in play mode. More...
 
static bool DrawUnselectedAreaMarkers [get]
 Should unselected area markers be drawn? Only relevant when not in play mode. More...
 
static float PointMappingDistance [get]
 Maximum distance a point will try to be mapped to the NavGraph. Used in performance critical functions (e.g. mapping a NavAgents position) and should be as small as possible. More...
 
static float InitiateUpdateInterval [get]
 Time between NavGraph updates. NavGraph queues changes to apply them in batch at this interval. Lower values will lower performance. More...
 
static int PathfinderThreadCount [get]
 Amount of threads used for pathfinding. NOTE: WebGL doesn't support threads. If you build for WebGL this number is meaningless. More...
 
static bool DrawGraphWhilePlaying [get]
 Draw the NavGraph while in play mode? More...
 
static float ClosestToSegmentMaxDistance [get]
 Maximum distance to search for the nearest NavGraph position to a point. Used in functions to e.g. map a mouse cursor click to a nav position. Make it as large as you want. More...
 
static float NavSurfaceLineWidth [get]
 Line width of NavGraph/NavSurface visualization. More...
 
static float NavAreaMarkerLineWidth [get]
 Line width of NavAreaMarker visualization (only visible in playmode) More...
 

Detailed Description

Contains all project wide settings for PathBerserker2d.

Find it at Edit/Project Settings/PathBerserker2d

Member Function Documentation

◆ EnsureNavLinkTypeExists()

static int PathBerserker2d.PathBerserker2dSettings.EnsureNavLinkTypeExists ( int  linkType)
static

If the linkType does not exists, returns 0

◆ EnsureNavTagExists()

static int PathBerserker2d.PathBerserker2dSettings.EnsureNavTagExists ( int  navTag)
static

If the NavTag does not exists, returns 0

◆ GetLinkTypeColor()

static Color PathBerserker2d.PathBerserker2dSettings.GetLinkTypeColor ( int  linkType)
static

Get color associated with specific link type.

◆ GetLinkTypeName()

static string PathBerserker2d.PathBerserker2dSettings.GetLinkTypeName ( int  linkType)
static

Get the human readable name of a specific link type.

◆ GetNavTagColor()

static Color PathBerserker2d.PathBerserker2dSettings.GetNavTagColor ( int  navTag)
static

Get the assigned color of a specific NavTag.

Property Documentation

◆ ClosestToSegmentMaxDistance

float PathBerserker2d.PathBerserker2dSettings.ClosestToSegmentMaxDistance
staticget

Maximum distance to search for the nearest NavGraph position to a point. Used in functions to e.g. map a mouse cursor click to a nav position. Make it as large as you want.

◆ DrawGraphWhilePlaying

bool PathBerserker2d.PathBerserker2dSettings.DrawGraphWhilePlaying
staticget

Draw the NavGraph while in play mode?

◆ DrawUnselectedAreaMarkers

bool PathBerserker2d.PathBerserker2dSettings.DrawUnselectedAreaMarkers
staticget

Should unselected area markers be drawn? Only relevant when not in play mode.

◆ DrawUnselectedLinks

bool PathBerserker2d.PathBerserker2dSettings.DrawUnselectedLinks
staticget

Should unselected links be drawn? Only relevant when not in play mode.

◆ DrawUnselectedSubstractors

bool PathBerserker2d.PathBerserker2dSettings.DrawUnselectedSubstractors
staticget

Should unselected substractors be drawn? Only relevant when not in play mode.

◆ DrawUnselectedSurfaces

bool PathBerserker2d.PathBerserker2dSettings.DrawUnselectedSurfaces
staticget

Should unselected surfaces be drawn? Only relevant when not in play mode.

◆ InitiateUpdateInterval

float PathBerserker2d.PathBerserker2dSettings.InitiateUpdateInterval
staticget

Time between NavGraph updates. NavGraph queues changes to apply them in batch at this interval. Lower values will lower performance.

◆ NavAreaMarkerLineWidth

float PathBerserker2d.PathBerserker2dSettings.NavAreaMarkerLineWidth
staticget

Line width of NavAreaMarker visualization (only visible in playmode)

◆ NavLinkTypeColors

Color [] PathBerserker2d.PathBerserker2dSettings.NavLinkTypeColors
staticget

Array of all NavTag colors

◆ NavLinkTypeNames

string [] PathBerserker2d.PathBerserker2dSettings.NavLinkTypeNames
staticget

Array of all link type names

◆ NavSurfaceLineWidth

float PathBerserker2d.PathBerserker2dSettings.NavSurfaceLineWidth
staticget

Line width of NavGraph/NavSurface visualization.

◆ NavTagColors

Color [] PathBerserker2d.PathBerserker2dSettings.NavTagColors
staticget

Array of all NavTag colors

◆ NavTags

string [] PathBerserker2d.PathBerserker2dSettings.NavTags
staticget

Array of all NavTag names

◆ PathfinderThreadCount

int PathBerserker2d.PathBerserker2dSettings.PathfinderThreadCount
staticget

Amount of threads used for pathfinding. NOTE: WebGL doesn't support threads. If you build for WebGL this number is meaningless.

◆ PointMappingDistance

float PathBerserker2d.PathBerserker2dSettings.PointMappingDistance
staticget

Maximum distance a point will try to be mapped to the NavGraph. Used in performance critical functions (e.g. mapping a NavAgents position) and should be as small as possible.


The documentation for this class was generated from the following file: