com.codingame.gameengine.module.entities

Class Group

java.lang.Object

com.codingame.gameengine.module.entities.Entity<Group>

com.codingame.gameengine.module.entities.Group

public class Group
extends Entity<Group>

A Group is an Entity which acts as a container for other entities.

Method Summary

Modifier and Type	Method and Description
void	add(Entity<?>... entities) Adds the given Entity instances to this Group.
void	remove(Entity<?> entity) Separates the given entity from this Group.

Methods inherited from class com.codingame.gameengine.module.entities.Entity

getAlpha, getId, getRotation, getScaleX, getScaleY, getX, getY, getZIndex, isVisible, setAlpha, setAlpha, setRotation, setRotation, setScale, setScale, setScaleX, setScaleX, setScaleY, setScaleY, setVisible, setX, setX, setY, setY, setZIndex

Methods inherited from class java.lang.Object

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

Method Detail

remove

public void remove(Entity<?> entity)

Separates the given entity from this Group.

Parameters:

entity - the Entity to be removed from this group, if it is part of it.

add

public void add(Entity<?>... entities)

Adds the given Entity instances to this Group.

The entities will be displayed within a container controlled by this Group.

Parameters:

entities - the Entity instances to be added to this group.

Throws:

java.lang.IllegalArgumentException - if at least one given Entity is already in a Group.