[This is preliminary documentation and is subject to change.]
Event delegates and data.
Types
| All Types | Classes | Interfaces |
| Name | Description | |
|---|---|---|
| ChatSendingEventArgs | Provides data for Chat.Sending event. Cancelable.
FormattedMessage and recipientList properties may be changed. | |
| ChatSentEventArgs | Provides data for Chat.Sent event. Immutable. | |
| CheckedForUpdatesEventArgs | Provides data for Updater.CheckedForUpdates event. Immutable. | |
| CheckingForUpdatesEventArgs | Provides data for Updater.CheckingForUpdates event. Allows changing the URL. Cancelable. | |
| CommandCalledEventArgs | Provides data for CommandManager.CommandCalled event. Immutable. | |
| CommandCallingEventArgs | Provides data for CommandManager.CommandCalling event. Cancelable. | |
| CommandRegisteredEventArgs | Provides data for CommandManager.CommandRegistered event. Immutable. | |
| CommandRegistringEventArgs | Provides data for CommandManager.CommandRegistering event. Cancelable. | |
| ConfigKeyChangedEventArgs | Provides data for Config.keyChanged event. Immutable. | |
| ConfigKeyChangingEventArgs | Provides data for Config.KeyChanging event. Allows modification of the value. Cancelable. | |
| CrashedEventArgs | Provides for Logger.Crashed event. Crash reporting can be canceled. | |
| DrawOperationBeginningEventArgs | ||
| DrawOperationEventArgs | ||
| ForesterBlockPlacingEventArgs | ||
| HeartbeatSendingEventArgs | Provides data for Heartbeat.Sending event. Cancelable.
HeartbeatData may be modified, Uri and GetSercerUri may be changed. | |
| HeartbeatSentEventArgs | Provides data for Heartbeat.Sent event. Immutable. | |
| IPBanCancelableEventArgs | Provides data for IPBanList.AddingIPBan and RemovingIPBan events. Cancelable. | |
| IPBanEventArgs | Provides data for IPBanList.AddedIPBan and RemovedIPBan events. Immutable. | |
| IPlayerEvent | An EventArgs for an event that directly relates to a particular player. | |
| IPlayerInfoEvent | An EventArgs for an event that directly related to a particular PlayerInfo. | |
| IWorldEvent | An EventArgs for an event that directly relates to a particular world. | |
| LogEventArgs | Provides data for Logger.Logged event. Immutable. | |
| MainWorldChangedEventArgs | Provides data for WorldManager.MainWorldChanged event. Immutable. | |
| MainWorldChangingEventArgs | Provides data for WorldManager.MainWorldChanging event. Cancelable. | |
| PlayerBeingKickedEventArgs | Provides data for Player.BeingKicked event. Cancelable. | |
| PlayerClickedEventArgs | Provides data for Player.Clicked event. Immutable. | |
| PlayerClickingEventArgs | Provides data for Player.Clicking event. Cancelable.
Coords, Block, and Action properties may be changed. | |
| PlayerConnectedEventArgs | Provides data for Player.Connected event. StartingWorld property may be changed.
Make sure to check IsFake property. | |
| PlayerConnectingEventArgs | Provides data for Player.Connecting event. Cancelable. | |
| PlayerDisconnectedEventArgs | Provides data for Player.Disconnected event. Immutable.
Make sure to check IsFake property. | |
| PlayerEventArgs | Provides basic data for player-related events. | |
| PlayerHideChangedEventArgs | Provides data for Player.HideChanged event. Immutable. | |
| PlayerInfoBanChangedEventArgs | Provides data for PlayerInfo.BanChanged event. Immutable. | |
| PlayerInfoBanChangingEventArgs | Provides data for PlayerInfo.BanChanging event. Cancelable.
Reason and Announce properties may be changed. | |
| PlayerInfoBeingCreatedEventArgs | Provides data for PlayerInfo.BeingCreated event. Cancelable.
Allows changing StartingRank. | |
| PlayerInfoCreatedEventArgs | Provides data for PlayerInfo.Created event. Immutable. | |
| PlayerInfoFrozenChangedEventArgs | Provides data for PlayerInfo.FrozenChanged event. Immutable. | |
| PlayerInfoFrozenChangingEventArgs | Provides data for PlayerInfo.FrozenChanging event. Cancelable.
Announce property may be changed. | |
| PlayerInfoMuteChangedEventArgs | Provides data for PlayerInfo.MuteChanged event. Immutable. | |
| PlayerInfoMuteChangingEventArgs | Provides data for PlayerInfo.MuteChanging event. Cancelable.
Duration and Announce properties may be changed. | |
| PlayerInfoRankChangedEventArgs | Provides data for PlayerInfo.RankChanged event. Immutable. | |
| PlayerInfoRankChangingEventArgs | Provides data for PlayerInfo.RankChanging event. Cancelable. | |
| PlayerJoinedWorldEventArgs | Provides data for Player.JoinedWorld event. Immutable. | |
| PlayerJoiningWorldEventArgs | Provides data for Player.JoiningWorld event. Cancelable.
Allows overriding the text that is shown on connection screen. | |
| PlayerKickedEventArgs | Provides data for Player.Kicked event. Immutable. | |
| PlayerMovedEventArgs | Provides data for Player.Moved event. Immutable. | |
| PlayerMovingEventArgs | Provides data for Player.Moving event. Cancelable. | |
| PlayerPlacedBlockEventArgs | Provides data for Player.PlacedBlock event. Immutable. | |
| PlayerPlacingBlockEventArgs | Provides data for Player.PlacingBlock event. Result may be overridden. | |
| SearchingForPlayerEventArgs | ||
| SearchingForWorldEventArgs | Provides data for WorldManager.SearchingForWorld event. Allows changing the results. | |
| SessionConnectingEventArgs | Provides data for Server.SessionConnecting event. Cancelable. | |
| SessionDisconnectedEventArgs | Provides data for Server.SessionDisconnected event. Immutable. | |
| ShutdownEventArgs | ||
| UriChangedEventArgs | Provides data for Heartbeat.UriChanged event. Immutable. | |
| WorldCreatedEventArgs | Provides data for WorldManager.WorldCreated event. Immutable. | |
| WorldCreatingEventArgs | Provides data for WorldManager.WorldCreating event. Allows renaming. Cancelable. |