Home Commands Examples Getting Started With Scripts Global Keywords
ClientTickEvent LevelTickEvent LivingTickEvent PlayerTickEvent ServerTickEvent TickEvent TickEventPhase TickEventType
DetonateExplosionEvent DifficultyChangeEvent Event EventResult ExplosionEvent FurnaceFuelBurnTimeEvent StartExplosionEvent
BracketHandlers ForgeBracketDumpers ForgeBracketValidators
Previous
LivingTickEvent ServerTickEvent
Next

PlayerTickEvent

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.forge.api.event.tick.PlayerTickEvent;

Extends

PlayerTickEvent extends TickEvent.

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.forge.api.event.tick.PlayerTickEvent>(event => {
    println("PlayerTickEvent ran!");
});

Members

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

Return Type: bool

cancelable() as bool
script.zs
// PlayerTickEvent.cancelable() as bool;
event.cancelable();

Return Type: bool

canceled
Getter
script.zs
// PlayerTickEvent.canceled as bool
event.canceled

Return Type: bool

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

Parameters:

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

Return Type: bool

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

Parameters:

cancel Type: bool
every
every(ticks as int, event as function(t as PlayerTickEvent) as void)
script.zs
// PlayerTickEvent.every(ticks as int, event as function(t as PlayerTickEvent) as void);
event.every(myInt, myConsumer);

Parameters:

ticks Type: int
event Type: function(t as PlayerTickEvent) as void
hasResult
Getter
script.zs
// PlayerTickEvent.hasResult as bool
event.hasResult

Return Type: bool

hasResult() as bool
script.zs
// PlayerTickEvent.hasResult() as bool;
event.hasResult();

Return Type: bool

phase
Getter
script.zs
// PlayerTickEvent.phase as TickEventPhase
event.phase

Return Type: TickEventPhase

player
Getter
script.zs
// PlayerTickEvent.player as Player
event.player

Return Type: Player

result
Getter
script.zs
// PlayerTickEvent.result as EventResult
event.result

Return Type: EventResult

Setter
script.zs
// PlayerTickEvent.result = (result as EventResult);
event.result = myResult;

Parameters:

result Type: EventResult
result() as Result
script.zs
// PlayerTickEvent.result() as EventResult;
event.result();

Return Type: EventResult

result(result as Result)
script.zs
// PlayerTickEvent.result(result as EventResult);
event.result(myResult);

Parameters:

result Type: EventResult
setAllow
setAllow()
sets the event's result to allow
script.zs
// PlayerTickEvent.setAllow();
event.setAllow();
setDefault
setDefault()
sets the event's result to default
script.zs
// PlayerTickEvent.setDefault();
event.setDefault();
setDeny
setDeny()
sets the event's result to deny
script.zs
// PlayerTickEvent.setDeny();
event.setDeny();
side
Getter
script.zs
// PlayerTickEvent.side as LogicalSide
event.side

Return Type: LogicalSide

type
Getter
script.zs
// PlayerTickEvent.type as TickEventType
event.type

Return Type: TickEventType

Previous
LivingTickEvent ServerTickEvent
Next