TBM2_API_Reference

Classes

Filter by category:

C++	TBM_ActionGameMinimapWidget TBM	Minimap that dynamically updates zoom and tilt based on player speed
C++	TBM_BlipMarkerWidget TBM	Shows a marker blip with a number
C++	TBM_BlipQueryWidget TBM	Allows cycling through the owner player's blip queries (to display different sets of blips)
C++	TBM_BlipTargetWidget TBM
C++	TBM_BlipTransformInterface	## UInterface cannot be documented ##
C++	TBM_BlipWaypointWidget TBM	Shows a waypoint blip that is created by the user by clicking on the menu map widget
C++	TBM_BlipWidget TBM	Customized blip widget
C++	TBM_DeveloperSettings (Tile Based Minimap) TBM	Configure the Tile Based Minimap plugin
C++	TBM_GPSWidget TBM	Displays the GPS route on the minimap
C++	TBM_GridTriggerBox TBM	A box used to register minimap grids (levels). If a player enters a registered grid their displayed grid changes
C++	TBM_MarkerBlipComponent TBM	Adds a dynamic blip with optional 3D marker above the owner
C++	TBM_MenuMapWidget TBM	Widget showing a big menu map with interactable blips
C++	TBM_MinimapWidget TBM	Base class for map widgets
C++	TBM_PlayerBlipComponent TBM	Manages player related blips, should be added to PlayerState for proper replication
C++	TBM_PlayerState TBM	Exposes player unique ID for correct player blip replication
C++	TBM_ReplicationProxyComponent TBM	Handles TBM replication. Replicates blips and goals
C++	TBM_StaticBlipComponent TBM	The component simply wraps the subsystems add blip functions so it's usually better to use them directly It can be useful as a way to place icons around your level however. Transform (location, rotation and scale) is sourced from the component or it's owner
C++	TBM_Subsystem (Tile Based Minimap Subsystem) TBM	TBM Subsystem is the central managing point of the plugin - collects grid and blip data - manages blips (icons) which then map widgets use as source for adding blip widgets - keeps track of blip queries per player (used to filter displayed blips) - keeps track of registered grids (for dynamic grid switching) - shows/hides zones (used to highlight specific parts of the level on the map widgets) - keeps track of the blips that specific players use as GPS target
C++	TBM_TileGridDebugWidget TBM	Debug widget showing currently loaded tiles
C++	TBM_TileGridMaterialWidget TBM	Uses simple UImage widgets to display the grid. Transform is calculated through it's materials. Player cannot interact with blips.
C++	TBM_TileGridPanelWidget TBM	Uses uniform grid panel to display the grid Should be used for grids that can be interacted with (like menu map widgets)
C++	TBM_TileGridWidget TBM	Base class responsible for loading and displaying the minimap tiles in a grid
C++	TBM_TileRenderer TBM	Renders and saves radar tiles onto the disk
C++	TBM_ZoneBlipComponent TBM	Adds a blip that shows areas on the map based on the box dimensions

Structs

FTBM_BlipClientTransform

Client side information about replicated blip transform

Properties:

FVector	ClientLocation
float	ClientRotation

FTBM_BlipDataBasic

Holds the core blip data. Can be used for static blips

Properties:

FGameplayTag	BlipSetup	Blip setup ID (tag); corresponds to subsystem's collected data
FGameplayTag	EffectsSetup	Blip effects ID (tag); corresponds to subsystem's collected data
FGameplayTagContainer	InstanceTags	Tags assigned to this specific blip instance
FLinearColor	ColorOverride	Optional color override. Ignored if alpha is set to zero
FVector	InitialLocation	The world location of the blip
float	InitialRotation	The blip yaw rotation
bool	SourceRotation	Whether to rotate the blip in the direction of the location source (minimap rotation or source component in case of dynamic blips)
FVector2D	InitialScale	Scale multiplier for this blip instance
uint8	AdditionalZOrder	Added on top of the z order from the blip setup
ETBM_BlipReplicationType	ReplicationType	Whether to use the replicator component to replicate the blip Blips still can be replicated if the owner is replicated so this setting should be disabled for most of the blips if possible
bool	OverrideClientData	If true replicated server blip data overrides current client blip data when the blip replicates. This affects basic data so client side dynamic data is intact

FTBM_BlipDataDynamic

Dynamic blip. Location and rotation is optionally sourced from the specified object

Properties:

TSoftObjectPtr<UObject>	TransformContext	Pointer to the object that is used as source location and rotation of the blip. By default this can be set to an actor or a scene component only unless the object implements blip transform interface
TSoftObjectPtr<UObject>	LifetimeContext	Pointer to the object that manages the blip lifetime, eg. blip will be destroyed if this is null and lifetime handling is set to remove
ETBM_BlipSourceDestroyHandling	LifetimeHandling	What should happen when the lifetime context is invalid? NOTES: Users need to manually remove the blip if the blip isn't set to remove itself after the object is destroyed

FTBM_BlipQuery

Used to query blips that should be displayed on the minimap. This is useful for hiding/showing certain blips that match tag query (eg. the user can hide blips in menu map widget). Each query is identified by a tag. SetupTag query is based on blip setup tags (FTBM_BlipSetupInfo->Tags). InstanceTag query is based on an actual blip instance (FTBM_BlipBasic->BlipDataBasic->InstanceTags). The SetupTag query is applied first then the InstanceTag query is applied afterwards. Calling Update functions with empty tags will reset the tags to the specified default ones

Properties:

FGameplayTag	DefaultSetupQuery	Default setup query to apply when no other query is applied
FGameplayTag	DefaultInstanceQuery	Default instance query to apply when no other query is applied
FGameplayTag	CurrentSetupQuery	Currently applied setup query
FGameplayTag	CurrentInstanceQuery	Currently applied instance query
TMap	BlipSetupTagQueries	Setup tag query list
TMap	BlipInstanceTagQueries	Instance tag query list

FTBM_BlipSetupInfo

Holds information required to display a blip (icon) on map widgets

Properties:

TSubclassOf<UTBM_BlipWidget>	WidgetClass	Default widget of the blip
TSoftObjectPtr<UMaterialInterface>	Material	Blip widget material; if invalid "Texture" will be used instead
TSoftObjectPtr<UMaterialInterface>	TransformMaterial	Used when the minimap widget has bUseMaterialTransform set to true. In such case a simple UImage widget will be created and the transformations will be done in the material itself. This removes the pixel jittering effect and the blip transform data has to be sent to the material itself
TSoftObjectPtr<UTexture2D>	Texture
ETBM_BlipType	BlipType
FLinearColor	Color
FVector2D	Scale
FVector2D	Pivot
int32	ZOrder	Display order
FTBM_GPSVisuals	GPSPathVisuals	GPS route visual settings if the blip is used as GPS target
FText	Description	Text that appears on the blip's tooltip
FGameplayTagContainer	Tags	Tags specific to this blip setup
FGameplayTagContainer	BlacklistedGridTags	The blip won't be displayed if the currently active grid is in this list
TSet	BlacklistedGrids	Additional FName list if not using tags
bool	NetInterpLocation	Whether to smoothly interpolate replicated blip location
float	MaxInterpSquaredDistance	Max distance difference between current and replicated locations before the location is snapped
bool	NetInterpRotation	Whether to smoothly interpolate replicated blip rotation
FDataTableRowHandle	CustomData

FTBM_BlipWidgetContext

Holds data about an actual blip image inside a minimap widget

Properties:

FName	BlipName	Blip ID
TWeakObjectPtr<UWidget>	BlipWidget	Pointer to a spawned blip widget
bool	IsMaterialBased	Wheter the blip uses the blip material for the transformations
FVector	WorldLocation	Origin location of the blip
FVector2D	DesiredPosition	Blip position on the UI
double	DesiredAngle	Blip rotation on the UI
double	NetInterpAngle	Base angle for interpolation
FVector2D	BaseScale	Base scale before applying scale effects
FVector2D	DesiredScale	Actual scale of the blip on the UI
double	DesiredOpacity
bool	Sticky	Whether the blip should be sticked to the border
bool	LoadingData	Whether the blip material/texture is currently async loading

FTBM_EffectsInfo

Blip effects allow the blip to be smoothly fade depending on the distance to the border of the minimap

Properties:

FVector4	OpacitybyDistance	Opacity based on distance ratio to the minimap border. XY: the range of the effect; X - minimap center, Y - minimap border. ZW: the opacity itself. Set X and Y to 0.0f to disable the effect. NOTE: if the effect isn't disabled and W is bigger than 0.0f the blip will be sticked to the minimap border.
FVector4	ScalebyDistance	Scale based on distance ratio to the minimap border. XY: the range of the effect; X - minimap center, Y - minimap border. ZW: the scale itself. Set X and Y to 0.0f to disable the effect. NOTE: if the effect isn't disabled and W is bigger than 0.0f the blip will be sticked to the minimap border.
float	HeightSwitch	Change appearance depending on the height distance of the player and the blip. Set to <= 0.0f to disable
bool	SticktoGrid	Whether the blip should be scaled along with the grid zoom so it looks like it's glued to it
FDataTableRowHandle	CustomData

FTBM_GPSGoal

GPS Goal points to the blip we want to draw GPS route to

Properties:

FUniqueNetIdRepl	PlayerID	The player we want to draw the GPS route for
FName	BlipName	The target blip
bool	GoalOverride	Whether to override all of the player's active goals with this one
bool	Replicated	Whether the goal is replicated

FTBM_GPSStaticPath

Similar to goals but only draws a static predefined route

Properties:

FName	PathName	Unique name of this path
TWeakObjectPtr<APlayerController>	OwningPlayer
TArray	Path	World 2D locations
FTBM_GPSVisuals	Visuals	The appearance of the path on the UI (color)

FTBM_GPSVisuals

Holds information about the appearance of GPS routes

Properties:

bool	SourceColorfromBlip	The path color is sourced from the blip itself
FLinearColor	Tint	This color is used in case the path color is not sourced from the blip
bool	AntiAlias
float	Thickness

FTBM_GridTransform

Runtime info about the grid widget in a minimap widget

Properties:

FTransform	GridWorldTransform	World grid transform Position: grid world offset Rotation: grid world rotation Scale: grid world size (for X and Y it's tile count * tile world radius, Z is taken from the trigger box)
bool	CanUpdateUI	Whether the minimap UI can be updated (is valid)
FVector2D	GridUISize	Grid UI size, ie. tile count * widget UI size
FVector	WorldOrigin	Minimap world origin (eg. player position)
FVector	AdjustedWorldOrigin	Minimap world origin adjusted by offset and grid reuse
FVector	FinalWorldOrigin	Final world origin. May be adjusted by the user (eg. by map panning effect)
FVector2D	LocalOrigin	WorldOrigin in local grid space
FVector2D	FinalLocalOrigin	FinalWorldOrigin in local grid space
FVector2D	MinimapUISize	UI size of the minimap widget
FVector2D	Position	Grid UI position
double	Angle	Grid UI Rotation
double	NorthYaw	Grid UI North rotation
double	Zoom	Grid UI scale (zoom)
double	Tilt	Grid UI tilt
FVector2D	CenterOffset	Grid UI center offset

FTBM_MenuMapKeyBindings

Holds the menu map interaction key bindings

Properties:

TSet	BlipInteraction
TSet	BlipTeleport
TSet	QuitKeys
TSet	ZoomOutKeys
TSet	ZoominKeys
TSet	PanningKeys
TSet	FilterBlipsNext
TSet	FilterBlipsPrevious

FTBM_MenuMapSettings

Holds the menu map widget settings

Properties:

bool	ResetPositiononVisibilityChange	Whether to reset the menu map position and zoom when the player enters menu map (after it was hidden) Only works when the widget is shown due to visibility change (not recreated) If false keeps user's panning offset and zoom
double	ZoomInterpSpeed	How fast to interp to desired zoom
double	ZoomSpeedMultiplier	Zooming speed
double	KeyZoomAmount	How much to zoom if the zoom comes from a key (keyboard, pad)
double	PanningOverscrollSpeed	Overscroll interp speed for mouse panning
FVector2D	PanningLimitMultiplier	Panning limits; set to (0.5, 0.5) to limit panning to grid borders
double	KeyPanningSpeed	Panning speed from keys (keyboard, pad)
double	KeyPanningSpeedIncreaseTime	How much time it takes to use full panning speed
float	MarkerAddTime	How much time it takes while holding waypoint add key to add a marker instead
bool	DestroyonQuit	Whether to destroy or hide the widget on quit
bool	ForceGConQuit	Whether to force garbage collection on widget destruct

FTBM_MinimapInfo

Holds data required to display a grid on a minimap widget

Properties:

FTBM_TileGridInfo	TileGridInfo	The grid dimensions
TMap	TexturesPath	The path to the folder containing the tile textures
FString	TextureName	The filename of the textures without the tile number
int32	IndexOffset	Offset to tile ID in the texture name (so eg. first tile starts at index 01 instead of 00)
TMap	LQImages	LQ images of the grids (optional)
TMap	BGColors	Background colors
int32	Priority	Display priority. Eg. interiors should have higher priority than the main level
TMap	PerWidgetInfo	Per widget class info

FTBM_MinimapPerWidgetInfo

Custom data for specific minimap widget classes

Properties:

float	DefaultZoom
FVector2D	ZoomLimit
FDataTableRowHandle	CustomData

FTBM_MinimapSettings

Holds information about a minimap widget

Properties:

float	TickRate	Update rate of the minimap widget
ETBM_MinimapRotationMode	RotationMode
ETBM_MinimapShape	Shape
TSoftObjectPtr<UMaterialInterface>	ShapeMaskMaterials	Mask materials for each shape
float	Opacity	Grid opacity
FVector2D	CenterOffset	Offset of the minimap origin if using rectangle shape. Circle is unsupported for now
FVector	EdgeDistanceOffset	Mannually adjust the minimap edge distance (useful when the minimap mask is smaller than the minimap's desired size) NOTE: X is for circle shape, Y and Z for rectangle shape
ETBM_MinimapRotationDirection	NorthDirection	The direction towards which the minimap is rotated, ie. North direction
FGameplayTag	TileColorPath	The path ID from the minimap data table which points to tile texture folder. Default one is used if empty
FTBM_TileLoaderSettigs	TileLoaderSettings
double	DefaultTilt
double	DefaultAreaSize	Default shown world area size. Ie. default zoom
double	BlipSizeMultiplier	Blip size multiplier that affects all blips displayed by this widget
FGameplayTagQuery	BlipSetupQuery	The minimap displays blips that match this query only. Uses setup tags (FTBM_BlipSetupInfo->Tags)
FGameplayTagQuery	BlipInstanceQuery	Additionally to setup query the minimap won't display blips whose InstanceTags don't match this query (FTBM_BlipBasic->BlipDataBasic->InstanceTags)
bool	UseMaterialTransform	Whether the blip material should perform blip transformations Blips in this mode don't have the pixel jittering effect but it has a few drawbacks: - Blip material has to be setup correctly for it to work - Blips are not interactable The best use case for it is for the small minimaps in the corner of the screen since we don't want ugly jittering and we don't need any interaction with the blips
float	RectTopPadding	In case of using both circle and rectangle minimaps, this should be used to adjust the rectangle minimap size (so the circle is unaffected)

FTBM_MinimapSpeedSettings

Dynamic speed and tilt settings

Properties:

bool	EnableSpeedZoom
FVector4	SpeedZoomSettings	Speed to zoom mapping. XY is the speed range and ZW is the corresponding zoom range
double	ZoomInterpSpeed	How quick zoom interpolation is
bool	EnableSpeedTilt
bool	ForceTilt	Whether the minimap is always tilted ignoring the speed tilt
double	MinTilt	Tilt value at max speed
FVector2D	TiltSpeedEnableRange	Defines the speed range tilt is enabled/disabled. X - enable, Y - disable
double	TiltInterpSpeed	How quick tilt interpolation is

FTBM_RadarColorMapping

TBM Radar Color Mapping

Properties:

TMap	Colors	Colors assigned per physical material
FTBM_RadarColors	FallbackColors	Used if no physical material was found NOTE: usually GEngine->DefaultPhysMaterial is used if nothing is assigned in the material or as overrides
FTBM_RadarColors	LandscapeColors	Used on landscapes
FLinearColor	BackgroundColor	BG color passed to minimap info data table
TEnumAsByte<ESceneCaptureSource>	SceneCaptureSource
TEnumAsByte<ETextureRenderTargetFormat>	RenderFormat
float	TargetGamma
bool	SRGB
TArray	ConsoleCommands	Console commands to set when capturing tiles

FTBM_RadarColors

Color data assigned to a primitive

Properties:

TObjectPtr<UMaterialInterface>	MeshMaterial	The material to assign to a primitive
FLinearColor	Color	The color to assign to a primitive (as a parameter into the mesh material)
FVector	MeshOffset	World position offset (useful for fixing Z fighting issues)

FTBM_RegisteredGrid

Holds information about a registered grid instance

Properties:

FGameplayTag	GridTag	The grid to register (tag)
FName	GridName	The grid to register (name)
FGameplayTag	IdentifierTag	ID of this register info. Used for the equal check (if empty grid transform is used instead)
FTransform	GridTransform	The transform of the grid itself (where in the world it is displayed)
TArray	Triggers	The list of triggers. If any of the trigger is overlapped by the player their UI map will change the displayed grid
FBox	TriggerBounds	Combined bounds of all the triggers. Used for simplified fast checks

FTBM_RegisteredGridTrigger

Holds information about a single grid trigger (world transform and shape)

Properties:

FTransform

TriggerTransform

World transform of the trigger

FTBM_TileGridInfo

Holds information about the number of tiles and the world size of a grid

Properties:

int32	Rows
int32	Columns
float	TileWorldSize

FTBM_TileLoaderSettigs

Holds information about tile loading

Properties:

float	TileLoaderTickRate	Update rate of the grid switch and tile loader
int32	MaxAmountOfTilesProcessedforLoading	If this limit is exceeded no tiles are loaded at all This value is calculated based on the player's screen corners Basically game calculates the amount of tiles that would fit into the displayed area and checks if the number is equal or smaller than this value
int32	MaxAmountOfLoadedTiles	Maximum amount of loaded (in memory) tile textures Garbage collection is forced if this limit is exceeded Set to <= 0 to disable (won't trigger GCs) DOES NOT WORK IN EDITOR
int32	MaxAmountOfDisplayedTiles	Maximum amount of displayed tile textures. Should be smaller than the above value (unless that setting is disabled)
bool	CanEverForceGC	Whether the widget is allowed to trigger garbage collection at all
float	ForcedGCInterval	Limits forced GCs to once per the given value (in seconds)
float	ScreenScaleMultiplier	Changes the area that is used for displaying tiles (ie. scales the screen size for the tile loader)
float	ScreenScaleDownStep	If we're exceeding the limit of max amount of tiles to display 'scale down' the screen gradually to skip the tiles near the screen borders This value is subtracted from current scale down ratio each step Scale down ratio is a value between 0.0 and 1.0 (eg. setting to 0.1f will use 10 steps in worst case)

Enums

ETBM_BlipReplicationType	ETBM Blip Replication Type	NotReplicated Static Dynamic RepClientSide ETBM_MAX (ETBM MAX)
ETBM_BlipSourceDestroyHandling	Defines what to do with a blip if it's source location component is destroyed/streamed out (dynamic blips)	KeepLastLocation InitialLocation Remove ETBM_MAX (ETBM MAX)
ETBM_BlipType	BLIPS	FixedUI World Area ETBM_MAX (ETBM MAX)
ETBM_MenuMapPanningState	ETBM Menu Map Panning State	NotPanning MousePanning KeyPannning ETBM_MAX (ETBM MAX)
ETBM_MinimapRotationDirection	Defines the minimap rotation (north) direction	nY (Negative Y) X (Positive X) nX (Negative X) Y (Positive Y) ETBM_MAX (ETBM MAX)
ETBM_MinimapRotationMode	Defines the minimap rotation mode	Fixed Rotating ETBM_MAX (ETBM MAX)
ETBM_MinimapShape	Defines the minimap shape	Circle Rectangle Num ETBM_MAX (ETBM MAX)
ETBM_PlayerBlipReplicationMethod	ETBM Player Blip Replication Method	UniqueNetId PlayerId PlayerName ETBM_MAX (ETBM MAX)