Anvil.API.Events.OnMapPinChangePin Class Reference

Called when a player is about to change an existing map pin. More...

Inheritance diagram for Anvil.API.Events.OnMapPinChangePin:

Collaboration diagram for Anvil.API.Events.OnMapPinChangePin:

Classes
class	Factory

Properties
int	Id [get]
	Gets the unique identifier for this map pin. More...
string?	Note [get]
	Gets the note that was set on the map pin. More...
NwPlayer	Player = null! [get]
	Gets the player that is changing the map pin. More...
Vector3	Position [get]
	Gets the position that the pin was placed at. More...
bool	PreventPinChange [get, set]
	Gets or sets if this pin change event should be prevented. More...
Properties inherited from Anvil.API.Events.IEvent
NwObject?	Context [get]

Detailed Description

Called when a player is about to change an existing map pin.

Property Documentation

Id

int Anvil.API.Events.OnMapPinChangePin.Id

get

Gets the unique identifier for this map pin.

Note

string? Anvil.API.Events.OnMapPinChangePin.Note

get

Gets the note that was set on the map pin.

Player

NwPlayer Anvil.API.Events.OnMapPinChangePin.Player = null!

get

Gets the player that is changing the map pin.

Position

Vector3 Anvil.API.Events.OnMapPinChangePin.Position

get

Gets the position that the pin was placed at.

PreventPinChange

bool Anvil.API.Events.OnMapPinChangePin.PreventPinChange

getset

Gets or sets if this pin change event should be prevented.

---

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

• NWN.Anvil/src/main/API/Events/Native/MapEvents/OnMapPinChangePin.cs