API

API Reference

Summary

1. Tag Packs
2. Hooks

---

Tag Packs

OIF.RegisterTagPack(tagPack)

This will register a Tag Pack, note that tag packs registered using this method do not persist, if the module that register a Tag Pack like this gets removed or disabled, the Tag Pack will not be loaded.

---

Hooks

After Melee Preparation

Hooks.on('oifWeaponMeleePostPrepare', (data) => {})

This hook fires after the data that will be used on the melee animation gets prepared, and before the animation gets played.

After Melee Hit Animation

Hooks.on('oifWeaponMeleeHitPostAnimation', (data) => {})

This hook fires after the melee hit animation is played, and before the interaction and sound.

After Melee Hit Interaction

Hooks.on('oifWeaponMeleeHitPostInteraction', (data) => {})

This hook fires after the melee hit interaction.

After Melee Hit Sound

Hooks.on('oifWeaponMeleeHitPostSound', (data) => {})

This hook fires after the melee hit sound.

After Melee Throw Animation

Hooks.on('oifWeaponMeleeThrowPostAnimation', (data) => {})

This hook fires after the melee throw animation is played, and before the interaction and sound.

After Melee Throw Interaction

Hooks.on('oifWeaponMeleeThrowPostInteraction', (data) => {})

This hook fires after the melee throw interaction.

After Melee Throw Sound

Hooks.on('oifWeaponMeleeThrowPostSound', (data) => {})

This hook fires after the melee throw sound.

After Ranged Preparation

Hooks.on('oifWeaponRangedPostPrepare', (data) => {})

This hook fires after the data that will be used on the ranged animation gets prepared, and before the animation gets played.

After Ranged Animation

Hooks.on('oifWeaponRangedPostAnimation', (data) => {})

This hook fires after the ranged animation is played, and before the interaction and sound.

After Ranged Interaction

Hooks.on('oifWeaponRangedPostInteraction', (data) => {})

This hook fires after the ranged interaction.

After Ranged Sound

Hooks.on('oifWeaponRangedPostSound', (data) => {})

This hook fires after the ranged sound.

After Lighting Preparation

Hooks.on('oifItemLightingPostPrepare', (data) => {})

This hook fires after the data that will be used on the lighting gets prepared, before it gets applied and before the sound.

After Lighting Light Apply

Hooks.on('oifItemLightingLightPostApply', (data) => {})

This hooks fires after the lighting light gets applied.

After Lighting Light Sound currently not implemented

Hooks.on('oifPostItemLightingLightSound', (data) => {})

This hook fires after the lighting light sound.

After Lighting Extinguish Apply

Hooks.on('oifItemLightingExtinguishPostApply', (data) => {})

This hooks fires after the lighting extinguish gets applied.

After Lighting Extinguish Sound currently not implemented

Hooks.on('oifPostItemLightingExtinguishSound', (data) => {})

This hook fires after the lighting extinguish sound.