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.

import crafttweaker.forge.api.event.tick.PlayerTickEvent;

Extends

PlayerTickEvent extends TickEvent.

Listening to the event

This event can be listened to like so:

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

Members

Cancels the event. Same as setCanceled(true)

// PlayerTickEvent.cancel();
event.cancel();

// PlayerTickEvent.cancelable as bool
event.cancelable

Return Type: bool

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

Return Type: bool

// PlayerTickEvent.canceled as bool
event.canceled

Return Type: bool

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

Parameters:

cancel: bool Type: bool

// PlayerTickEvent.canceled() as bool;
event.canceled();

Return Type: bool

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

Parameters:

cancel: bool Type: bool

// PlayerTickEvent.every(ticks as int, event as function(t as PlayerTickEvent) as void);
event.every(myInt, myConsumer);

Parameters:

ticks: int Type: int

event: function(t as PlayerTickEvent) as void Type: function(t as PlayerTickEvent) as void

// PlayerTickEvent.hasResult as bool
event.hasResult

Return Type: bool

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

Return Type: bool

// PlayerTickEvent.phase as Phase
event.phase

Return Type: TickEventPhase

// PlayerTickEvent.player as Player
event.player

Return Type: Player

// PlayerTickEvent.result as Result
event.result

Return Type: EventResult

// PlayerTickEvent.result = (result as Result);
event.result = myResult;

Parameters:

result: EventResult Type: EventResult

// PlayerTickEvent.result() as Result;
event.result();

Return Type: EventResult

// PlayerTickEvent.result(result as Result);
event.result(myResult);

Parameters:

result: EventResult Type: EventResult

sets the event's result to allow

// PlayerTickEvent.setAllow();
event.setAllow();

sets the event's result to default

// PlayerTickEvent.setDefault();
event.setDefault();

sets the event's result to deny

// PlayerTickEvent.setDeny();
event.setDeny();

// PlayerTickEvent.side as LogicalSide
event.side

Return Type: LogicalSide

// PlayerTickEvent.type as Type
event.type

Return Type: TickEventType