YATS/Forge Documentation
 All Classes Namespaces Files Functions Variables Enumerator Pages
cpw.mods.fml.common.ITickHandler Interface Reference
Inheritance diagram for cpw.mods.fml.common.ITickHandler:
cpw.mods.fml.common.IScheduledTickHandler cpw.mods.fml.common.modloader.BaseModTicker cpw.mods.fml.common.SingleIntervalHandler

Public Member Functions

void tickStart (EnumSet< TickType > type, Object...tickData)
 
void tickEnd (EnumSet< TickType > type, Object...tickData)
 
EnumSet< TickTypeticks ()
 
String getLabel ()
 

Detailed Description

Tick handler for mods to implement and register through the TickRegistry

The data available to each tick is documented in the TickType

Author
cpw

Member Function Documentation

String cpw.mods.fml.common.ITickHandler.getLabel ( )
void cpw.mods.fml.common.ITickHandler.tickEnd ( EnumSet< TickType type,
Object...  tickData 
)

Called at the "end" phase of a tick

Multiple ticks may fire simultaneously- you will only be called once with all the firing ticks

Parameters
type
tickData

Implemented in cpw.mods.fml.common.modloader.BaseModTicker, and cpw.mods.fml.common.SingleIntervalHandler.

EnumSet<TickType> cpw.mods.fml.common.ITickHandler.ticks ( )

Returns the list of ticks this tick handler is interested in receiving at the minute

Implemented in cpw.mods.fml.common.modloader.BaseModTicker, cpw.mods.fml.client.modloader.ModLoaderKeyBindingHandler, and cpw.mods.fml.common.SingleIntervalHandler.

void cpw.mods.fml.common.ITickHandler.tickStart ( EnumSet< TickType type,
Object...  tickData 
)

Called at the "start" phase of a tick

Multiple ticks may fire simultaneously- you will only be called once with all the firing ticks

Parameters
type
tickData

Implemented in cpw.mods.fml.common.modloader.BaseModTicker, and cpw.mods.fml.common.SingleIntervalHandler.


The documentation for this interface was generated from the following file: