H3lp Yours3lfDocs
api

ScriptContext

Identify the OpenMW script context in code shared across script types.

require 'scripts.s3.scriptContext' → ScriptContext

Use ScriptContext when one shared Lua module genuinely needs to behave differently in local, player, global, menu, or load scripts. It tells you where you are; it does not give you permissions you do not have.

local ScriptContext = require 'scripts.s3.scriptContext'

if ScriptContext.get() == ScriptContext.Types.Player then
    print('Running in the player script')
end

The enum contains Types.Local, Types.Global, Types.Player, Types.Menu, and Types.Load. get() returns one member or raises if detection fails.

On load, the module probes context-specific OpenMW modules. get() checks global, load, and menu before using the attached object to distinguish local from player.

Use it when one plain module needs a context-appropriate implementation, as LogMessage does. Prefer separate modules when branching obscures permissions or lifecycle.

  • LogMessage: Send diagnostic text through the output path available to the current context.
  • S3lf: Read the attached object's common fields, records, and actor data.
  • isOpenMW: Detect whether code is running inside OpenMW's Lua runtime.