Anvil
Anvil.API.Events.OnMapPinAddPin Class Reference

Called when a player is about to place a map pin. More...

+ Inheritance diagram for Anvil.API.Events.OnMapPinAddPin:
+ Collaboration diagram for Anvil.API.Events.OnMapPinAddPin:

Classes

class  Factory
 

Properties

string Note = null! [get]
 Gets the note that was set on the map pin. More...
 
NwPlayer Player = null! [get]
 Gets the player that placed the pin. More...
 
Vector3 Position [get]
 Gets the position that the pin was placed at. More...
 
bool PreventPinAdd [get, set]
 Gets or sets if this pin add event should be prevented. More...
 
- Properties inherited from Anvil.API.Events.IEvent
NwObjectContext [get]
 

Detailed Description

Called when a player is about to place a map pin.

Property Documentation

◆ Note

string Anvil.API.Events.OnMapPinAddPin.Note = null!
get

Gets the note that was set on the map pin.

◆ Player

NwPlayer Anvil.API.Events.OnMapPinAddPin.Player = null!
get

Gets the player that placed the pin.

◆ Position

Vector3 Anvil.API.Events.OnMapPinAddPin.Position
get

Gets the position that the pin was placed at.

◆ PreventPinAdd

bool Anvil.API.Events.OnMapPinAddPin.PreventPinAdd
getset

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


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