Package com.codingame.gameengine.module.toggle

Class ToggleModule

java.lang.Object

com.codingame.gameengine.module.toggle.ToggleModule

All Implemented Interfaces:

Module

public class ToggleModule
extends Object
implements Module

Author:

Jean Porée This module allows you to display or hide elements of the GraphicEntityModule using the viewer's options menu.

Method Summary

Modifier and Type	Method	Description
void	displayOnToggleState(Entity<?> entity, String toggle, boolean state)	Will display the entity only when the toggle state matches the state you set
void	onAfterGameTurn()	Called by the game manager after calling the Referee's gameTurn method.
void	onAfterOnEnd()	Called by the game manager after calling the Referee's onEnd method.
void	onGameInit()	Called by the game manager after calling the Referee's init method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

onGameInit

public void onGameInit()

Description copied from interface: Module

Called by the game manager after calling the Referee's init method. The module must be registered to the game manager.

Specified by:

onGameInit in interface Module

onAfterGameTurn

public void onAfterGameTurn()

Description copied from interface: Module

Called by the game manager after calling the Referee's gameTurn method. The module must be registered to the game manager.

Specified by:

onAfterGameTurn in interface Module

onAfterOnEnd

public void onAfterOnEnd()

Description copied from interface: Module

Called by the game manager after calling the Referee's onEnd method. The module must be registered to the game manager.

Specified by:

onAfterOnEnd in interface Module

displayOnToggleState

public void displayOnToggleState(Entity<?> entity,
 String toggle,
 boolean state)

Will display the entity only when the toggle state matches the state you set

Parameters:

entity - which will be displayed

toggle - the name of the toggle you want to use

state - the state of the toggle where the entity will be displayed at