Pathing Status

Updated: 2026-07-01

Table of Contents

• TacO Pack Format
  • Organization
  • Map
  • Visual
  • Filters
  • Dynamic Interactions
  • Compatibility notes
  • History
• Pathing Scripts
  • API Support
  • Additions and Changes
  • Lua Runtime
  • Wishlist
  • History

TacO Pack Format

An overview of TaimiHUD's support for pathing pack attributes and features.

See also: Issue tracker

Organization

Searching, filtering, and customization UI has been evolving since pre-release and continues to receive significant revisions over time.

Map

They show up!

Visual

Finer visual polish and customization are often unsupported, though sometimes similar functionality can be tweaked globally by user settings.

Filters

API-dependent filters are currently in beta testing and slated for the next major release as v0.4.
Besides festivals, everything else is only available as part of the v0.5 interaction alpha test and is planned to follow the API release.

Dynamic Interactions

Anything related to triggers is currently in active development and is the focus of the ongoing alpha test.
See the test details for caveats.

Compatibility notes

• TaimiHUD may pay attention to bh- prefixed attributes if a generic fallback isn't present :<
• The XML parser tends to be strict, so pay attention to logs in Nexus (and increase verbosity to see All messages) when diagnosing problems

History

v0.3.x

Basic initial support

v0.4.x

Planned release for API and achievement filters

v0.5.x

Slated to include interaction triggers, info popups, clipboard copying, etc

Pathing Scripts

TaimiHUD is in early stages of prototyping compatibility with pack.lua and most related scripting features offered by Blish HUD's Pathing Module.

API Support

There is no standard protocol for unimplemented functions yet - expect anything from interrupted script execution with an error to returning nil or placeholder values if a request couldn't be processed.

• ☑ PathingVersion: fixed to 1.11.999+taimi to indicate compatibility with recent versions of the module
• ☑ Pathing.Version: fixed to 1.11.999
• ☑ Pathing:IsVersionAtLeast(v)
• ☑ Debug:Print
• ☑ Debug:Warn
• ☑ Debug:Error
• ☑ Debug:Watch
• ☑ Debug:ClearWatch
• ☑ Pack:Require
• ☑ Mumble
  • ☐ Mumble.Tick, Mumble.TimeSinceTick
  • ☐ Mumble.CurrentMumbleMapName: TODO
  • ☑ Mumble.IsAvailable
  • ☑ Mumble.CurrentMap
    • ☑ .Id, .IsCompetitiveMode
    • ☐ .Type: TODO
  • ☑ Mumble.Info
    • ☑ .BuildId, .IsGameFocused
  • ☑ Mumble.PlayerCamera
    • ☐ .NearPlaneRenderDistance, .FarPlaneRenderDistance: TODO
    • ☑ .FieldOfView
    • ☑ .Position, .Forward
  • ☑ Mumble.PlayerCharacter
    • ☑ .Position, .Forward
    • ☐ .CurrentMount: TODO
    • ☑ .IsInCombat, .IsCommander
    • ☑ .Race, .Specialization, .TeamColorId
  • ☑ Mumble.UI
    • ☑ .CompassRotation, .CompassSize, .IsCompassRotationEnabled, .IsCompassTopRight
    • ☐ .MapCenter, .MapPosition: TODO unknown type and fields
    • ☑ .MapScale, .IsMapOpen
    • ☑ .IsTextInputFocused
    • ☐ .UISize: TODO
  • ☐ MumbleMapType, MumbleMountType, MumbleRaceType, MumbleUiSize: TODO? unclear if these are provided as actual lua tables or just for reference in docs
• ☑ Menu
  • ☑ Menu:Add
  • ☑ Menu:Remove
  • ☑ .OnClick
  • ☑ .Tooltip
  • ☑ .CanCheck, .Checked
• ☑ Event:OnTick
• ☑ User:SetClipboard(value)
• ☑ Vector3
  • ☑ .X, .Y, .Z
  • ☑ I:Vector3
  • ☑ :Length, :Dot
  • ☑ :Normalize, :Cross
  • ☑ binary ops
• ☑ GameTime
  • ☑ .ElapsedGameTime, .TotalGameTime
  • ☑ TimeSpan
• ☑ Color
  • ☑ .R, .G, .B, .A
  • ☑ I:Color
• ☑ Guid
  • ☑ :ToBase64
  • ☑ I:Guid
• ☑ Texture
  • ☐ .Width, .Height: TODO? stubbed out because loading texture immediately would block execution
  • ☑ I:Texture(Pack, path)
  • ☒ I:Texture(web_id): TODO
• ☑ World
  • ☑ :CategoryByType
  • ☑ :PathableByGuid
  • ☑ :PathablesByGuid
  • ☑ :MarkerByGuid
  • ☐ :GetClosestMarker, World:GetClosestMarker(filtered): TODO
  • ☐ :GetClosestMarkers, World:GetClosestMarkers(filtered): TODO
  • ☑ :TrailByGuid
• ☑ Category
  • ☑ .Name, .DisplayName, .Namespace, .DefaultToggle, .IsHidden, .IsSeparator, .Root: getters
  • ☐ .LoadedFromPack: TODO
  • ☑ .Parent: TODO
  • ☐ setters: TODO (many implemented but not all, types/names may be incorrect, etc)
  • ☑ :GetOrAddCategoryFromNamespace
  • ☑ :IsVisible
  • ☑ :Show
  • ☑ :Hide
  • ☑ :GetMarkers, :GetMarkers(recursive)
  • ☑ :GetTrails, :GetTrails(recursive)
• ☑ IPathable: TODO
  • ☐ getters: TODO (many implemented but not all, types/names may be incorrect, etc)
  • ☐ setters: TODO (")
  • ☐ :Focus: TODO
  • ☐ :Unfocus: TODO
  • ☐ :Interact: TODO
  • ☑ (Trail):Remove, (Marker):Remove
  • ☑ (Trail):GetBehavior, (Marker):GetBehavior: mostly functional, but filter status and operations are scoped to the marker and not the individual behaviour (meaning that if a marker has multiple behaviours attached, they will all claim to be the reason for filtering even if only 1 filter is responsible - and GetBehavior("CopyModifier"):Trigger() may trigger the whole marker and perform more actions than just the copy)
  • ☑ .BehaviorFiltered: TODO
  • ☒ Behaviors[]: TODO
  • ☑ DistanceToPlayer
  • ☒ DrawOrder: TODO: unclear if this is an override or updated every frame or what? likely to stay unimplemented or stubbed out unless it turns out to be useful to someone and the behaviour is well-defined
• ☑ Marker
  • ☐ getters: TODO (many implemented but not all, types/names may be incorrect, etc)
  • ☐ setters: TODO (")
    • ☑ :SetPos, :SetRot
    • ☑ :SetTexture(path)
    • ☑ :SetTexture(web_id)
  • ☑ Pack:CreateMarker
  • ☑ I:Marker
• ☑ Trail: TODO
  • ☐ getters: TODO (many implemented but not all, types/names may be incorrect, etc)
  • ☐ setters: TODO (")
    • ☑ :SetTexture(path)
    • ☑ :SetTexture(web_id)
  • ☑ Pack:CreateTrail: might work now?
  • ☐ I:Trail: TODO
  • ☒ :SetPoints: TODO
• ☐ IBehavior: semi-functional

Undocumented API

TODO: check whether these were deprecated or if the reference is just out of date...

• ☑ Debug:Info
• ☐ Debug:ShowMessage
• ☑ User:SetClipboard(value, message)
• ☐ User:ShowInfo(message) -> string key
• ☐ User:HideInfo(key)
• ☑ Storage:UpsertValue: 2 overloads
• ☑ Storage:DeleteValue: 2 overloads
• ☑ Storage:ReadValue: 2 overloads
• ☐ Mumble.UI.MapCenter and MapPosition type - Vector2?
• ☐ Mumble.UI.CompassSize type - Vector2 or Size2?
• ☑ _G.Packs = _G.World
• ☑ table.ToLson, table.FromLson

Ambiguous Behaviour

misc things to double-check:

• coordinate spaces: CreateMarker({ ypos = Mumble.PlayerCharacter.Position.Z }) implies that Vector3 positions could be in the swizzled "blishspace"? unclear if ypos == marker.Position.Y or Z - and what about marker:SetPosY()? trail:SetPoints()? How about marker.RotateXyz and marker:SetRotY()?
• how does a marker's Position field and marker:SetPosY() relate to the heightoffset attribute - included or excluded? Does DistanceToPlayer take the y offset into account or no? is the offset considered a superficial/visual modifier rather than something that adjusts anything meaningful about the position? (how about trigger ranges and focus etc?)
• instance fields like those on Vector3 are generally writable, right?
• are pathable attribute fields expected to work by reference, e.g. is marker.Position.X = new_x equivalent to marker:SetPosX(new_x)? if ineffective: is it an error to set, clobbered immediately, ignored and desync'd from real state, or what?
• are integer to number coercions wanted and/or needed for setters and methods?
• is the set of valid behaviour names a fixed/known enum?
• __tostring and other operators relevant at all, if so on what?
• any other missing details?
• does Mumble.IsAvailable account for temporary dropouts (like say loading screens, charsel, etc)? or only false if disabled?
• do the World search functions cover markers among all loaded packs or just the calling script's?
• will World expose markers for all maps or only the current map? if only current map, what about Category:GetMarkers()?
  • how persistent are changes to properties on markers for a map other than the one you currently are on?
• how persistent are changes to category properties?
• does changing maps wipe state and/or re-start pack.lua every time? if so, what about loading screens / waypoints? what about switching characters but reload onto the same map? (and if not, why aren't there map lifecycle events?)
• precise behaviour of script-filter isn't clear...
  • documentation says nothing about returning true/false to show or hide the marker, but the name implies it so... return true appears to mean it should filter or hide the marker?
  • is the filter function ever called for a marker that isn't visible? say the function filters a marker one frame, does it continue to call the filter function afterward to allow it to unhide, or is the script required to do so out-of-band?
  • once filtered, what state on the marker changes? is it considered BehaviorFiltered?
• what's a "load" in the context of script-once, presumably off-map markers aren't loaded? what if a marker is filtered until weekly reset and you enter its map, is it still loaded?
  • script-tick also presumably only runs if the marker is "loaded"?
• how does focus behave when dealing with auto-trigger markers - are both engaged simultaneously? after a marker is triggered (auto or manual), does it remain in focus? if BehaviorFiltered does it stay focused or unfocus upon filtering? can a filtered marker still become focused when you approach it?
• can a trail be focused or interacted via the api? presumably behaviours are able to filter trails, but dynamic capabilities seem unclear.
• tehstrails follows CreateMarker({ copy = "" }) up with m:GetBehavior("CopyModifier").CopyValue = next, is clearing the clipboard the first time you interact the intended behaviour? (our GetBehavior would return nil otherwise so I assume it's semi intentional though maybe a hack?)
• how does table.ToLson handle functions, userdata, etc - error or ignore or what? also is a __tolson metamethod a thing?
• if a marker is created under a category, can it inherit attrs from that type the same way it would've if created by xml?

References

• Tutorials and sample code
• API reference documentation
• TehsTrails was a motivating use-case for the feature
• Hero's Marker Pack appears to be a good stress test and destination for more intricate fight simulation logic than traditional timer descriptions.

Additions and Changes

(this section will be an incomplete mess throughout early development)

• ☑ TaimiVersion: addon version
• ☑ TaimiApiVersion: tracking api progress, currently: 0.0.1
• ☑ TaimiPlug: pack descriptor
• ☒ __tostring_debug? customizing console output
• ☐ Debug:X() multiple arg variants?
• ☑ Mumble.PlayerCharacter.Profession: TODO?
• ☐ Taimi.Pack:Remove(IPathable): TODO?
• ☒ Taimi.Account.Id: TODO (opt-in?)
• ☒ Taimi.Camera.Up
• ☒ all camera/player/etc vec3s changed to either mumble-local coords or in-game inches: TODO
• ☒ Taimi.Map.Instance: IP
• ☒ Taimi.Gameplay.IsLieutenant
• ☒ Taimi.Gameplay.IsDowned, Taimi.Gameplay.IsFlying, Taimi.Gameplay.IsGliding, Taimi.Gameplay.IsUnderwater, Taimi.Gameplay.IsFloating: TODO
• ☒ Taimi.Process.Id
• ☒ Taimi.Spatial.Camera, Taimi.Spatial.Player, Taimi.Spatial.ContinentScale, Taimi.Spatial:PosFromContinent for conversions to/from inches? TODO
• ☒ Taimi.Menu.NexusRoot: TODO
• ☒ Taimi.Menu.NexusQA: TODO
• ☐ Taimi.Overlay.IsTextInputFocused: TODO
• ☒ Taimi.Texture:HasMetadata, Taimi.Texture:LoadMetadata: TODO delayed vs blocking image decode and processing
• ☐ I:NamedTextureV1(id): explicit form of overloaded I:Texture(int)
• ☐ I:NamedTextureV2(id): string ID variant from API version 2
  • ☑ I:NamedTexture(id): overloaded variant for V1 or V2 IDs
  • ☒ I:WebTexture(url): TODO?
• ☒ Taimi.Api2: TODO
• ☒ Taimi.Http: TODO
• ☒ Taimi.Imgui: TODO

Lua Runtime

Some misc runtime characteristics to expect:

• currently targets lua 5.1 (luajit 2.1 backend, pluggable at build-time)
  • ☐ bit32: TODO?
• a number of standard library functions may be exposed as partial shims:
  • ☑ print as an alias to Debug:Print
  • ☑ require: partly provided
  • ☐ os.clock
  • ☐ os.date
  • ☐ os.time
  • ☐ os.difftime
  • ☐ stdlib for whatever is offered by pathing? coroutine, table.unpack+move, etc...
• see the unsecured setting if something's missing

Wishlist

• a designated subfolder as a substitute for LUA_PATH?
• some table to opt in to sharing data across pack boundaries
• query and/or poke all other packs?
• more UI primitives, events, etc.
• reflection for bindings to various stuff (bevy or macro or otherwise)
  maybe use as a general-purpose debug tool for taimihud (and/or pack) development?
• io.open for pack resources

Misc TODOs

• script.lua.enable datasource flag
• prompt and require opt-in to script execution per pack
• try out the tutorial examples
• empty packs should still load if they contain a script entry point?
• be intentional about anything provided from _G
  • export unfiltered _G and/or _ENV to scripts when unsecured, and to require()
• setter methods generally don't need &mut self
• fallback pack/root ID to longest common prefix
• repl (standalone)
• check if Pathing:IsVersionAtLeast(PathingVersion) is always be true under Blish HUD?

Polish

Much of the feature is functional but barebones:

• Vector3 metamethod polish: types and coersions? operand order? __le/__lt? __eq? __tostring?
• in-game debugging:
  • up/down command history, console output, improved UI, etc
  • debug watch navigation and formatting needs work
• Pathing:IsVersionAtLeast: allow requests ending in +taimi or similar to check against our real versioning scheme in a way that Pathing will always respond false?
  • TODO: consider version constraint queries or exposing more fine-grained feature flag requests

Issues

• Menu tooltips render poorly
• menu.CanCheck = false probably not fully working?
  • initial menu checkbox state may not display correctly until toggled

Pack Compatibility

Packs that generally work with minor issues:

• Movement On The World v34.5
  • tutorial won't loop around properly due to setting CopyValue = nil on the final marker
• TehsTrails v6.0.1
  • lightly tested, trail highlighting seems to work
• TehsTrails v5.2.0
  • alternate mount icons will break things and may require clearing settings to unset

Packs known to rely on missing features:

• Hero's Marker Pack sometimes in test scenarios but needs a few fixes for general use
  • wants os.date for dailies tracking and whatnot
  • HT sometimes works but broke again recently idk why

History

v0.5.x

Integration with new interaction systems

v0.4.x

Initial lua prototyping