LibResInfo-1.0

API / Callbacks

LibResInfo-1.0 provides the following callbacks to notify interested addons when resurrection-related actions or events occur.

LibResInfo_ResCastStarted

Fires when a group member starts casting a single-target resurrection spell on another group member.

Arguments:

  • targetUnit - string: the unitID of the target of the spell
  • targetGUID - string: the GUID of the target of the spell
  • casterUnit - string: the unitID of the unit casting the spell
  • casterGUID - string: the GUID of the unit casting the spell
  • endTime - number: the time when the spell will finish casting, comparable to GetTime()

LibResInfo_ResCastCancelled

Fires when a group member stops casting a single-target resurrection spell on another group member before the cast completes. This may happen if the caster deliberately cancels the spell, or if they are interrupted.

Arguments:

  • targetUnit - string: the unitID of the target of the spell
  • targetGUID - string: the GUID of the target of the spell
  • casterUnit - string: the unitID of the unit casting the spell
  • casterGUID - string: the GUID of the unit casting the spell

LibResInfo_ResCastFinished

Fires when a group member successfully finishes casting a single-target resurrection spell on another group member. This callback is always followed by the LibResInfo_ResPending callback.

Arguments:

  • targetUnit - string: the unitID of the target of the spell
  • targetGUID - string: the GUID of the target of the spell
  • casterUnit - string: the unitID of the unit casting the spell
  • casterGUID - string: the GUID of the unit casting the spell

LibResInfo_MassResStarted

Fires when a group member starts casting Mass Resurrection.

Arguments:

  • casterUnit - string: the unitID of the unit casting the spell
  • casterGUID - string: the GUID of the unit casting the spell
  • endTime - number: the time when the spell will finish casting, comparable to GetTime()

LibResInfo_MassResCancelled

Fires when a group member stops casting Mass Resurrection before the cast completes. This may happen if the caster deliberately cancels the spell, or if they are interrupted.

Arguments:

  • casterUnit - string: the unitID of the unit casting the spell
  • casterGUID - string: the GUID of the unit casting the spell

LibResInfo_MassResFinished

Fires when a group member successfully finishes casting Mass Resurrection. This callback is always followed by a LibResInfo_ResPending callback for each affected group member.

Arguments:

  • casterUnit - string: the unitID of the unit casting the spell
  • casterGUID - string: the GUID of the unit casting the spell

LibResInfo_ResPending

Fires when a group member receives a resurrection (either single-target or Mass Resurrection) from another group member. This coincides with the appearance of a popup dialog box on the target's screen asking them to accept or decline the resurrection. This callback is always preceded by a LibResInfo_ResCastFinished callback.

Arguments:

  • targetUnit - string: the unitID of the group member who recieved the resurrection
  • targetGUID - string: the GUID of the group member who recieved the resurrection
  • endTime - number: the time when the resurrection offer will expire, comparable to GetTime()
  • isSelfRes - boolean: true if the resurrection is available from a Soulstone cast on the unit before death, as opposed to a spell cast on the unit after death

LibResInfo_ResExpired

Fires when the resurrection available to a group member expires. This coincides with the disappearance of the popup dialog box on the target's screen asking them to accept or decline the resurrection. At this point, the resurrection is no longer available.

Also fires when a unit with an available resurrection goes offline or releases their spirit, as either of these actions will cancel the resurrection offer.

Arguments:

  • targetUnit - string: the unitID of the group member whose resurrection offer expired
  • targetGUID - string: the GUID of the group member whose resurrection offer expired

LibResInfo_ResUsed

Fires when a group member accepts an available resurrection. At this point, the unit is now alive. Also fires when a unit returns their spirit to their corpse while a spell-sourced resurrection is available.

Arguments:

  • targetUnit - string: the unitID of the group member whose resurrection offer expired
  • targetGUID - string: the GUID of the group member whose resurrection offer expired

Facts

Date created
Aug 23, 2012
Last updated
Dec 21, 2013

Author