Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide
AttackEntityEvent BonemealEvent CanContinueSleepingEvent CanPlayerSleepEvent CriticalHitEvent PlayerBreakSpeedEvent PlayerChangeGameModeEvent PlayerChangedDimensionEvent PlayerCloneEvent PlayerEvent PlayerFlyableFallEvent PlayerHarvestCheckEvent PlayerLoggedInEvent PlayerLoggedOutEvent PlayerNameFormatEvent PlayerRespawnEvent PlayerSetSpawnEvent PlayerWakeUpEvent TabListNameFormat TradeWithVillagerEvent
EntityEvent EntityJoinLevelEvent EntityLeaveLevelEvent EntityMobGriefingEvent EntityMountEvent EntityStruckByLightningEvent EntityTravelToDimensionEvent ProjectileImpactEvent
DetonateExplosionEvent DifficultyChangeEvent Event ExplosionEvent FurnaceFuelBurnTimeEvent ICancellableEvent StartExplosionEvent
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators
Previous
PlayerBreakSpeedEvent PlayerChangedDimensionEvent
Next

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
cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// PlayerChangeGameModeEvent.cancel();
event.cancel();
canceled
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
currentGameMode
Getter
script.zs
// PlayerChangeGameModeEvent.currentGameMode as GameType
event.currentGameMode

Return Type: GameType

entity
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

newGameMode
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
Previous
PlayerBreakSpeedEvent PlayerChangedDimensionEvent
Next