Anvil
Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent Class Reference

Triggered when a player clicks on a particular GUI interface. More...

+ Inheritance diagram for Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent:
+ Collaboration diagram for Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent:

Properties

ChatBarChannel ChatBarChannel [get]
 Gets the chat bar channel that is selected. Only valid in GuiEventType.ChatBarFocus and GuiEventType.ChatBarUnFocus type events. More...
 
EffectIconTableEntryEffectIcon [get]
 Gets the effect icon that was selected. Only valid in GuiEventType.EffectIconClick events. More...
 
NwObject EventObject = NWScript.GetLastGuiEventObject().ToNwObject()! [get]
 Gets the object data associated with this GUI event. More...
 
GuiEventType EventType = (GuiEventType)NWScript.GetLastGuiEventType() [get]
 Gets the GuiEventType that was triggered. More...
 
NwFeat FeatSelection [get]
 Gets the feat that was selected. Only valid in GuiEventType.CharacterSheetFeatClick events. More...
 
GUIPanel OpenedPanel [get]
 Gets the GUI panel that attempted to be opened. Only valid in GuiEventType.DisabledPanelAttemptOpen events. More...
 
NwPlayer Player = NWScript.GetLastGuiEventPlayer().ToNwPlayer()! [get]
 Gets the NwPlayer that triggered this event. More...
 
NwSkill SkillSelection [get]
 Gets the skill that was selected. Only valid in GuiEventType.CharacterSheetSkillClick events. More...
 
Vector3 Vector [get]
 Gets the vector payload included in this gui event. Only valid in GuiEventType.RadialOpen events. More...
 
- Properties inherited from Anvil.API.Events.IEvent
NwObjectContext [get]
 

Detailed Description

Triggered when a player clicks on a particular GUI interface.

Property Documentation

◆ ChatBarChannel

ChatBarChannel Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.ChatBarChannel
get

Gets the chat bar channel that is selected. Only valid in GuiEventType.ChatBarFocus and GuiEventType.ChatBarUnFocus type events.

◆ EffectIcon

EffectIconTableEntry? Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.EffectIcon
get

Gets the effect icon that was selected. Only valid in GuiEventType.EffectIconClick events.

◆ EventObject

NwObject Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.EventObject = NWScript.GetLastGuiEventObject().ToNwObject()!
get

Gets the object data associated with this GUI event.

GuiEventType.MinimapMapPinClick: The waypoint the map note is attached to. GuiEventType.CharacterSheetSkillClick: The owner of the character sheet.
GuiEventType.CharacterSheetFeatClick: The owner of the character sheet.
GuiEventType.PlayerListPlayerClick: The player that was clicked.
GuiEventType.PartyBarPortraitClick: The creature that was clicked.
GuiEventType.DisabledPanelAttemptOpen: For GUIPanel.CharacterSheet, the owner of the character sheet. For GUIPanel.Examine*, the object being examined.
GuiEventType.ExamineObject: The object being examined.
GuiEventType.ChatlogPortraitClick: The owner of the portrait that was clicked.
GuiEventType.PlayerlistPlayerTell: The selected player.

◆ EventType

GuiEventType Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.EventType = (GuiEventType)NWScript.GetLastGuiEventType()
get

Gets the GuiEventType that was triggered.

◆ FeatSelection

NwFeat Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.FeatSelection
get

Gets the feat that was selected. Only valid in GuiEventType.CharacterSheetFeatClick events.

◆ OpenedPanel

GUIPanel Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.OpenedPanel
get

Gets the GUI panel that attempted to be opened. Only valid in GuiEventType.DisabledPanelAttemptOpen events.

◆ Player

NwPlayer Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.Player = NWScript.GetLastGuiEventPlayer().ToNwPlayer()!
get

Gets the NwPlayer that triggered this event.

◆ SkillSelection

NwSkill Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.SkillSelection
get

Gets the skill that was selected. Only valid in GuiEventType.CharacterSheetSkillClick events.

◆ Vector

Vector3 Anvil.API.Events.ModuleEvents.OnPlayerGuiEvent.Vector
get

Gets the vector payload included in this gui event. Only valid in GuiEventType.RadialOpen events.


The documentation for this class was generated from the following file: