MeFe's Location API

MeFe's Location API

MeFe's Location API is a shared location provider for Gothic 1 Remake UE4SS Lua mods.

Important information for players

This mod is intended primarily for mod authors and as a dependency for other mods.

It does not add visible gameplay content or features by itself. Install it only when another mod lists MeFe's Location API as a requirement.

If none of your installed mods require it, this mod will have no practical effect.

Installation

MeFe_LocationAPIfolder into the game's

Modsfolder and make sure the mod is enabled.

A compatible UE4SS installation is required.

What the API provides

The API detects the player's current named game area by reading Gothic 1 Remake's internal region data:

G1RPlayerState

→ RegionComponent

→ ApplicableTraits

→ AreaTagRegionTraitThe detected areas use hierarchical tags.

Area. OldCamp

Area. OldCamp. OuterRing

Area. OldCamp. Castle

Area. XardasTower

Area. XardasTower. Bedroom

Area. XardasTower. RooftopTerrace

Area. AbandonedMine

Area. AbandonedMine. MainChamber

Area. AbandonedMine. Temple. Cavern. 01The API publishes:

• []the exact active area tag;[/]

  []the top-level major area tag;[/]

  []whether a valid location is currently available;[/]

  []the current detection source;[/]

  []revision counters that allow client mods to detect changes;[/]

  []a configurable location scan interval requested by client mods.[/]

For example:

Area. XardasTower. Bedroom

Area. XardasTowerWhen multiple area traits are active, the API selects the trait with the highest game priority. When priorities are equal, the more specific tag is selected.

During loading, travel or gaps between area volumes, the API may temporarily publish

valid=falsewith

source=no-locationor another runtime status.

Information for mod authors

The cross-mod API is published through UE4SS shared variables.

Default prefix:

MeFe. LocationAPI.Public shared variables

MeFe. LocationAPI.version

MeFe. LocationAPI.ready

MeFe. LocationAPI.rev

MeFe. LocationAPI.status_rev

MeFe. LocationAPI.valid

MeFe. LocationAPI.stale

MeFe. LocationAPI.source

MeFe. LocationAPI.exact.tag

MeFe. LocationAPI.major.tagField definitions

versionThe installed Location API version.

readyIndicates that the API provider has initialized.

revIncreases when any of the following changes:

• []location validity;[/]

  []detection source;[/]

  []exact area tag;[/]

  []major area tag.[/]

status_revA separate revision reserved for status-only changes that do not change the current location.

validIndicates whether a valid active area tag is currently available.

staleIndicates whether the published state is marked as outdated. Version 1. 0. 0 normally publishes

sourceThe current detection source or runtime state.

Common values include:

active-traits

no-location

waiting-player

unknownexact.tagThe complete detected area tag.

Area. AbandonedMine. MainChamber. UpperElevatorAreamajor.tagThe top-level area derived from the exact tag.

Area. AbandonedMine

Client helper

The package includes:

Scripts/locationapi_client.luaThis file can be copied into another UE4SS Lua mod and loaded with

It provides:

IsAvailable()

GetVersion()

GetRevision()

GetStatusRevision()

GetSource()

GetExactTag()

GetMajorTag()

GetCurrentAreaInfo()

RequestRefreshInterval(modName, intervalMs)

ClearRefreshInterval(modName)

OnAreaChanged(modName, pollMs, callback, options)Basic integration

local LocationAPI = require("locationapi_client")

local state = LocationAPI. GetState()

if state.ready and state.valid and state.exact then

print("Exact area: " .. tostring(state.exact.tag))

print("Major area: " .. tostring(

state.major and state.major.tag

endReceiving location changes

local LocationAPI = require("locationapi_client")

LocationAPI. OnAreaChanged(