TickEvent

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.TickEvent;

Extends

TickEvent extends Event.

Members

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

Return Type: bool

cancelable() as bool
script.zs
// TickEvent.cancelable() as bool;
myTickEvent.cancelable();

Return Type: bool

Getter
script.zs
// TickEvent.canceled as bool
myTickEvent.canceled

Return Type: bool

Setter
script.zs
// TickEvent.canceled = (cancel as bool);
myTickEvent.canceled = myBool;

Parameters:

cancel Type: bool
canceled() as bool
script.zs
// TickEvent.canceled() as bool;
myTickEvent.canceled();

Return Type: bool

canceled(cancel as bool)
script.zs
// TickEvent.canceled(cancel as bool);
myTickEvent.canceled(myBool);

Parameters:

cancel Type: bool
Getter
script.zs
// TickEvent.hasResult as bool
myTickEvent.hasResult

Return Type: bool

hasResult() as bool
script.zs
// TickEvent.hasResult() as bool;
myTickEvent.hasResult();

Return Type: bool

Getter
script.zs
// TickEvent.phase as Phase
myTickEvent.phase

Return Type: TickEventPhase

Getter
script.zs
// TickEvent.result as Result
myTickEvent.result

Return Type: EventResult

Setter
script.zs
// TickEvent.result = (result as Result);
myTickEvent.result = myResult;

Parameters:

result Type: EventResult
result() as Result
script.zs
// TickEvent.result() as Result;
myTickEvent.result();

Return Type: EventResult

result(result as Result)
script.zs
// TickEvent.result(result as Result);
myTickEvent.result(myResult);

Parameters:

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

Return Type: LogicalSide

Getter
script.zs
// TickEvent.type as Type
myTickEvent.type

Return Type: TickEventType