GraphicEntityModule

java.lang.Object
- com.codingame.gameengine.module.entities.GraphicEntityModule

All Implemented Interfaces:

Module
```
public class GraphicEntityModule
extends java.lang.Object
implements Module
```
The GraphicEntityModule takes care of displaying and animating graphical entities on the replay of the game.

Use it by creating shapes, sprites, texts etc, then commiting their states to a certain moment of the frame. By default, the states are commited automatically at the end of the frame.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`commitEntityState(double t, Entity<?>... entities)` This entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as it is now.
`void`	`commitWorldState(double t)` Every entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as they are now.
`Circle`	`createCircle()` Creates a new Circle entity, its graphical counterpart will be created on the frame currently being computed.
`Group`	`createGroup(Entity<?>... entities)` Creates a new Group entity, its graphical counterpart will be created on the frame currently being computed.
`Line`	`createLine()` Creates a new Line entity, its graphical counterpart will be created on the frame currently being computed.
`Rectangle`	`createRectangle()` Creates a new Rectangle entity, its graphical counterpart will be created on the frame currently being computed.
`Sprite`	`createSprite()` Creates a new Sprite entity, its graphical counterpart will be created on the frame currently being computed.
`SpriteAnimation`	`createSpriteAnimation()` Creates a new Sprite animation, its graphical counterpart will be created on the frame currently being computed.
`Text`	`createText(java.lang.String string)` Creates a new Text entity, its graphical counterpart will be created on the frame currently being computed.
`World`	`createWorld(int width, int height)` Creates a new world data object to be used to compute all frames throughout the game.
`World`	`getWorld()`
`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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createWorld
```
public World createWorld(int width,
                         int height)
```
    Creates a new world data object to be used to compute all frames throughout the game.
    This method may only be called once. This method may not be called after the frames have started being computed.
    The world's width and height determine how the positions of all entities are mapped onto the viewer.
    
    Parameters:
    
    width - The number of units across the width of the visible part of the game. Default is 1920.
    
    height - The number of units across the height of the visible part of the game. Default is 1080.
    
    Returns:
    
    the world data object.
    
    Throws:
    
    java.lang.IllegalStateException - if the method is called more than once or after the game begins.
  - getWorld
```
public World getWorld()
```
    Returns:
    
    the world data currently being used for computing frames
  - commitWorldState
```
public void commitWorldState(double t)
```
    Every entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as they are now.
    Only the most recent commits are kept for a given t.
    
    If an entity hasn't changed since its previous commit, its commit is ignored.
    
    Parameters:
    
    t - The instant of the frame 0 ≥ t ≥ 1.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the t is not a valid instant.
  - commitEntityState
```
public void commitEntityState(double t,
                              Entity<?>... entities)
```
    This entity's graphical counterpart, at instant t of the frame being computed, will have the same properties as the java object as it is now.
    Only the most recent commit is kept for a given t.
    If the entity hasn't changed since its previous commit, the commit is ignored.
    
    Parameters:
    
    t - The instant of the frame 0 ≥ t ≥ 1.
    
    entities - The entity objects to commit.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the t is not a valid instant or id entities is empty.
  - createCircle
```
public Circle createCircle()
```
    Creates a new Circle entity, its graphical counterpart will be created on the frame currently being computed.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - createSprite
```
public Sprite createSprite()
```
    Creates a new Sprite entity, its graphical counterpart will be created on the frame currently being computed.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - createLine
```
public Line createLine()
```
    Creates a new Line entity, its graphical counterpart will be created on the frame currently being computed.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - createRectangle
```
public Rectangle createRectangle()
```
    Creates a new Rectangle entity, its graphical counterpart will be created on the frame currently being computed.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - createText
```
public Text createText(java.lang.String string)
```
    Creates a new Text entity, its graphical counterpart will be created on the frame currently being computed.
    
    Parameters:
    
    string - The default string for the text. Can be changed.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - createGroup
```
public Group createGroup(Entity<?>... entities)
```
    Creates a new Group entity, its graphical counterpart will be created on the frame currently being computed.
    A Group represents a collection of other entities. It acts as a container.
    
    Parameters:
    
    entities - 0 or more entities to immediately add to this group.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - createSpriteAnimation
```
public SpriteAnimation createSpriteAnimation()
```
    Creates a new Sprite animation, its graphical counterpart will be created on the frame currently being computed.
    
    Returns:
    
    the entity. Modify its properties to animate the graphical counterpart.
  - onGameInit
```
public final 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 final 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 final 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

Class GraphicEntityModule

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createWorld

getWorld

commitWorldState

commitEntityState

createCircle

createSprite

createLine

createRectangle

createText

createGroup

createSpriteAnimation

onGameInit

onAfterGameTurn

onAfterOnEnd