net.user1.union.api
Interface Module

All Known Implementing Classes:
MaxClients, MaxConcurrentConnection, MaxRooms

public interface Module

A module extends the functionality of the server or a specific room.


Method Summary
 boolean init(ModuleContext ctx)
          Called when the module is initialized.
 void shutdown()
          Called when the module is shutdown.
 

Method Detail

init

boolean init(ModuleContext ctx)
Called when the module is initialized. Use this method to perform any custom initialization in the module code. If the module code cannot perform initialization successfully then this method should return false which will cause the room to not be deployed to the server.

Returns:
false if the module failed to initialize, otherwise true.

shutdown

void shutdown()
Called when the module is shutdown. Use this method to cleanup any resources created by the module.



Copyright USER1 Subsystems Corporation - Tue Jan 28 2014, 05:05 PM -0500