PlayerChangeGameModeEvent

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.neoforge.api.event.entity.player.PlayerChangeGameModeEvent;

Extends

PlayerChangeGameModeEvent extends PlayerEvent.

Implements

PlayerChangeGameModeEvent implements the following interfaces:

ICancellableEvent

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.neoforge.api.event.entity.player.PlayerChangeGameModeEvent>(event => {
println("PlayerChangeGameModeEvent ran!");
});

Members

cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// PlayerChangeGameModeEvent.cancel();
event.cancel();
Getter
script.zs
// PlayerChangeGameModeEvent.canceled as bool
event.canceled

Return Type: bool

Setter
script.zs
// PlayerChangeGameModeEvent.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel Type: bool
canceled() as bool
script.zs
// PlayerChangeGameModeEvent.canceled() as bool;
event.canceled();

Return Type: bool

canceled(cancel as bool)
script.zs
// PlayerChangeGameModeEvent.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel Type: bool
Getter
script.zs
// PlayerChangeGameModeEvent.currentGameMode as GameType
event.currentGameMode

Return Type: GameType

Getter
script.zs
// PlayerChangeGameModeEvent.entity as Player
event.entity

Return Type: Player

Getter
script.zs
// PlayerChangeGameModeEvent.entity as LivingEntity
event.entity

Return Type: LivingEntity

Getter
script.zs
// PlayerChangeGameModeEvent.entity as Entity
event.entity

Return Type: Entity

Getter
script.zs
// PlayerChangeGameModeEvent.newGameMode as GameType
event.newGameMode

Return Type: GameType

Setter
script.zs
// PlayerChangeGameModeEvent.newGameMode = (newGameMode as GameType);
event.newGameMode = myGameType;

Parameters:

newGameMode Type: GameType