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. | |
| EffectIconTableEntry? | EffectIcon [get] |
| Gets the effect icon that was selected. Only valid in GuiEventType.EffectIconClick events. | |
| NwObject | EventObject = NWScript.GetLastGuiEventObject().ToNwObject()! [get] |
| Gets the object data associated with this GUI event. | |
| GuiEventType | EventType = (GuiEventType)NWScript.GetLastGuiEventType() [get] |
| Gets the GuiEventType that was triggered. | |
| NwFeat | FeatSelection [get] |
| Gets the feat that was selected. Only valid in GuiEventType.CharacterSheetFeatClick events. | |
| GUIPanel | OpenedPanel [get] |
| Gets the GUI panel that attempted to be opened. Only valid in GuiEventType.DisabledPanelAttemptOpen events. | |
| NwPlayer | Player = NWScript.GetLastGuiEventPlayer().ToNwPlayer()! [get] |
| Gets the NwPlayer that triggered this event. | |
| NwSkill | SkillSelection [get] |
| Gets the skill that was selected. Only valid in GuiEventType.CharacterSheetSkillClick events. | |
| Vector3 | Vector [get] |
| Gets the vector payload included in this gui event. Only valid in GuiEventType.RadialOpen events. | |
| Properties inherited from Anvil.API.Events.IEvent | |
Detailed Description
Triggered when a player clicks on a particular GUI interface.
Property Documentation
◆ EventObject
|
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.
The documentation for this class was generated from the following file:
- NWN.Anvil/src/main/API/Events/Game/ModuleEvents/ModuleEvents.OnPlayerGuiEvent.cs
