Anvil
Anvil.API.Events.OnServerCharacterSave Class Reference

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. More...

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

Classes

class  Factory
 

Properties

NwPlayer Player = null! [get]
 Gets the player that is being saved. More...
 
bool PreventSave [get, set]
 Gets or sets a value indicating whether the character should be prevented from being saved. More...
 
- Properties inherited from Anvil.API.Events.IEvent
NwObjectContext [get]
 

Detailed Description

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.

Property Documentation

◆ Player

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

Gets the player that is being saved.

◆ PreventSave

bool Anvil.API.Events.OnServerCharacterSave.PreventSave
getset

Gets or sets a value indicating whether the character should be prevented from being saved.


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