Namespace Anvil.API.Events
Classes
- AreaEvents
Built-in events associated with a specific area.
- AreaEvents.OnEnter
Called when a new NwGameObject has entered the NwArea.
- AreaEvents.OnExit
Called when an NwGameObject leaves the NwArea.
- AreaEvents.OnHeartbeat
Called at a regular interval (approx. 6 seconds).
- AreaOfEffectEvents
Built-in events for effects created with AreaOfEffect(PersistentVfxTableEntry, ScriptCallbackHandle?, ScriptCallbackHandle?, ScriptCallbackHandle?).
- AreaOfEffectEvents.OnEnter
Called when an object enters the area of effect.
- AreaOfEffectEvents.OnExit
Called when an object exits the area of effect.
- AreaOfEffectEvents.OnHeartbeat
Called at a regular interval (approx. 6 seconds).
- CreatureEvents
Built-in events associated with a specific creature.
- CreatureEvents.OnBlocked
Triggered when the NwCreature is blocked by a NwDoor.
- CreatureEvents.OnCombatRoundEnd
Triggered at the end of the NwCreature combat round.
- CreatureEvents.OnConversation
Called when this creature starts a conversation, or hears a message they are listening for.
- CreatureEvents.OnDamaged
Triggered by NwCreature when taken damage from NwGameObject.
- CreatureEvents.OnDeath
Triggered by NwCreature when killed by NwGameObject.
- CreatureEvents.OnDisturbed
Triggered by NwCreature when its inventory has been disturbed.
- CreatureEvents.OnHeartbeat
Called at a regular interval (approx. 6 seconds).
- CreatureEvents.OnPerception
Triggered by NwCreature when its perception is triggered by another NwCreature.
- CreatureEvents.OnPhysicalAttacked
Triggered by NwCreature when physically attacked by another NwCreature.
- CreatureEvents.OnRested
Triggered by NwCreature when resting.
- CreatureEvents.OnSpawn
Triggered by NwCreature upon spawning into the game.
- CreatureEvents.OnSpellCastAt
Triggered by NwCreature when a spell is cast upon it.
- DoorEvents
Built-in events associated with a specific door.
- DoorEvents.OnConversation
Called when this door starts a conversation, or hears a message they are listening for.
- EncounterEvents
Built-in events associated with a specific encounter.
- GameEventFactory
Event factory for built-in game events.
- ModuleEvents
Global module events.
- ModuleEvents.OnAcquireItem
Triggered whenever an NwItem is added to NwGameObject inventory.
- ModuleEvents.OnActivateItem
Triggered when an item that has the item property spell "Unique Power" (targeted) or "Unique Power - Self Only" (self) casts its spell.
- ModuleEvents.OnClientEnter
Triggered when a NwPlayer selects a character and logged into the module.
- ModuleEvents.OnClientLeave
Triggered when a NwCreature leaves the server.
- ModuleEvents.OnCutsceneAbort
Triggered when a NwPlayer tries to cancel a cutscene (ESC).
- ModuleEvents.OnHeartbeat
Triggered every server heartbeat (~6 seconds).
- ModuleEvents.OnModuleLoad
Triggered when the module is initially loaded. This event must be hooked in your service constructor, otherwise it will be missed.
- ModuleEvents.OnNuiEvent
Called when a player triggers an event in the NUI system.
- ModuleEvents.OnPlayerChat
Triggered when any NwPlayer sends a chat message. Private channel not hooked.
- ModuleEvents.OnPlayerDeath
Triggered when a NwPlayer dies.
- ModuleEvents.OnPlayerDying
Triggered when a NwPlayer enters a dying state (< 0 HP).
- ModuleEvents.OnPlayerEquipItem
Triggered when a NwCreature equips an NwItem.
- ModuleEvents.OnPlayerGuiEvent
Triggered when a player clicks on a particular GUI interface.
- ModuleEvents.OnPlayerLevelUp
Triggered when a NwPlayer levels up.
- ModuleEvents.OnPlayerRespawn
Triggered when a NwPlayer clicks the respawn button on the death screen.
- ModuleEvents.OnPlayerRest
Triggered when NwPlayer presses the rest button and begins to rest, cancelled rest, or finished rest.
- ModuleEvents.OnPlayerTarget
Triggered when a NwPlayer that has targeted something.
- ModuleEvents.OnPlayerTileAction
Triggered when a player performs an action on an area tile.
- ModuleEvents.OnPlayerUnequipItem
Triggered just before a NwCreature un-equips an NwItem.
- ModuleEvents.OnUnacquireItem
Triggered when a NwItem is removed from a NwCreature's inventory.
This event is also fired when an item stack is destroyed when combining with another item stack.
- OnChatMessageSend
Called when a chat message is about to be sent by an object.
- OnCheckEffectImmunity
Called when an effect is checking for creature immunities.
Use this event to force an effect to bypass creature immunities.
- OnClientConnect
Triggered when a player attempts to connect to the server (before character select).
This event can be cancelled to prevent a player from connecting to the server.
- OnClientDisconnect
Called when the player disconnects from the server.
This event is also called if the player connects, and then disconnects on the character select screen.
- OnCreatureAcquireItem
Called when a creature acquires an item. This event is skippable.
- OnCreatureCheckProficiencies
Called when an item is tested against a creature's proficiencies to determine if the creature may attempt to equip the item.
- OnDebugPlayVisualEffect
Called when a client attempts to spawn a visual effect.
- OnDebugRunScript
Called when a script has been requested to execute from the nwscript debug window.
- OnDebugRunScriptChunk
Called when a client has requested a script chunk to be executed.
- OnDispelMagicApply
Called when a DispelMagicAll(int) or DispelMagicBest(int) effect is applied to an object.
- OnDoorSetOpenState
Called when a door's open state is changed (open/closed/destroyed).
- OnEffectApply
Called when an effect is about to be applied to a creature.
- OnEffectRemove
Called when an effect is about to be removed from a creature.
- OnHealKitUse
Called when a heal kit is used by a creature.
- OnItemDecrementStackSize
Called when an item is destroyed, reducing the stack size of an item.
- OnItemDestroy
Called when an item is destroyed, deleting the item.
- OnItemScrollLearn
Called when a creature is about to learn a spell from a scroll.
- OnItemUnequip
Called when a creature attempts to unequip an item.
- OnLoadCharacterFinish
Called immediately after a player character is loaded by the server.
- OnMapPinAddPin
Called when a player is about to place a map pin.
- OnMapPinChangePin
Called when a player is about to change an existing map pin.
- OnMapPinDestroyPin
Called when a player is about to delete an existing map pin.
- OnObjectUse
Called when a creature is about to use an object.
- OnPlayerQuickChat
Called when a player uses a quick chat command.
- OnPolymorphApply
Called when a creature is about to be affected by a polymorph effect.
- OnPolymorphRemove
Called when a creature is about to lose a polymorph effect.
- OnServerCharacterSave
Called when the server is about to save a character to the server vault.
This is called once for every character when the server is exiting, when a player leaves the server, or when ExportSingleCharacter() & ExportAllCharacters() is called.
This event can be skipped to prevent the character from being saved.
- OnTrapDisarm
Called when a creature attempts to disarm a trap.
- OnTrapEnter
Called when a game object enters a trap trigger.
- OnTrapExamine
Called when a creature attempts to examine a trap.
- OnTrapFlag
Called when a creature attempts to flag a trap.
- OnTrapRecover
Called when a creature attempts to recover a trap.
- OnTrapSet
Called when a creature attempts to set a trap.
- OnTriggerEnter
Called when an object enters a trigger.
- OnUseSkill
Called when a creature attempts to use a skill.
- PlaceableEvents
Built-in events associated with a specific placeable.
- PlaceableEvents.OnClose
Called when NwCreature has closed a NwPlaceable.
- PlaceableEvents.OnConversation
Called when this placeable starts a conversation, or hears a message they are listening for.
- PlaceableEvents.OnDamaged
Called when NwGameObject has damaged NwPlaceable.
- PlaceableEvents.OnDeath
Called when NwCreature has destroyed NwPlaceable.
- PlaceableEvents.OnDisarm
Called when NwPlaceable has been disarmed.
- PlaceableEvents.OnDisturbed
Called when NwPlaceable inventory has been disturbed.
- PlaceableEvents.OnHeartbeat
Called every 6 seconds on NwPlaceable.
- PlaceableEvents.OnLeftClick
Called when NwPlaceable has been mousepad (left) clicked.
- PlaceableEvents.OnLock
Called when NwPlaceable has been locked.
- PlaceableEvents.OnOpen
Called when NwPlaceable has been opened.
- PlaceableEvents.OnPhysicalAttacked
Called when NwPlaceable has been physically attacked.
- PlaceableEvents.OnSpellCastAt
Called when Spell has been casted on NwPlaceable.
- PlaceableEvents.OnTrapTriggered
Called when NwPlaceable has a trap triggered.
- PlaceableEvents.OnUnlock
Called when NwPlaceable has been unlocked.
- PlaceableEvents.OnUsed
Called when NwPlaceable is being used.
- StoreEvents
Built-in events associated with a specific store.
- TriggerEvents
Built-in events associated with a specific trigger.