Additional Javascript API Reference

for full documentation, please go to RainbowMage's Original Wiki.

Functions

OverlayPluginApi.endEncounter() Function

Added on 0.3.3.12

Ends/splits current encounter, and save it.

This invokes ActGlobals.oFormActMain.EndCombat(true).

• Parameters
  • Nothing.
• Returns
  • Nothing.

Events

onLogLine event

0.3.3.14-, LogParse only

This event occurs every time when raw logline received from FFXIV_ACT_Plugin.

onLogLine event (deprecated)

0.3.3.13-14, MiniParse Only

This event occurs when you used in-game echo (/e message), and ACT-FFXIV Plugin correctly configured.

More types are planned like 'moveZone'.

document.addEventListener('onLogLine', function(event) {
  if(event.detail.isImported) return
  if(event.detail.type === 'echo') {
    console.log('You mumbled:', event.detail.message)
  }
})

Globals

ActXiv: Object (Obsolote)

-0.3.3.13, removed

Changes with onOverlayDataUpdate event's data.