[This is preliminary documentation and is subject to change.]
Provides data for Player.JoiningWorld event. Cancelable.
Allows overriding the text that is shown on connection screen.
Namespace: fCraft.EventsAssembly: fCraft (in fCraft.dll) Version: 0.6.3.2 (0.6.3.2)
Syntax
| C# |
public sealed class PlayerJoiningWorldEventArgs : EventArgs, IPlayerEvent, ICancelableEvent
Members
| All Members | Properties | Methods |
| Member | Description | |
|---|---|---|
| Cancel | ||
| Context | Context of the world change. | |
| Equals(Object) | (Inherited from Object.) | |
| Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| NewWorld | The world that player intends to join. May be same as OldWorld, if rejoining. | |
| OldWorld | Player's current world. May be null if player just connected, and is joining main. | |
| Player | Player who intends to join a world. | |
| TextLine1 | First line of text that is shown to the player on the loading screen.
Defaults to server name. May be changed. | |
| TextLine2 | First line of text that is shown to the player on the loading screen.
Defaults to world name or WoM cfg string. May be changed. | |
| ToString()()()() | (Inherited from Object.) |