GameObjectManager

java.lang.Object
- com.thekeirs.games.engine.GameObjectManager

All Implemented Interfaces:

GameView.IGameLogicService, GameView.IRedrawService, IMessageClient
```
public final class GameObjectManager
extends java.lang.Object
implements IMessageClient, GameView.IRedrawService, GameView.IGameLogicService
```
The central class of the game engine, responsible for keeping track of all the game objects helping them interact with the Android system.

One instance of this class is created by the main game Activity and provided to the GameView at startup time.

Field Summary

Fields
Modifier and Type Field and Description

MessageBus mBus
An instance of the MessageBus that can be used to send messages, assuming we start using that feature again.

Fields
Modifier and Type	Field and Description
`MessageBus`	`mBus` An instance of the `MessageBus` that can be used to send messages, assuming we start using that feature again.

Constructor Summary

Constructors
Constructor and Description
`GameObjectManager(MessageBus mbus, android.content.res.Resources res)` Called by the game's main Activity to set up all the game logic.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObject(GameObject obj)` Adds a `GameObject` or a subclass into the list of objects being managed.
`void`	`draw(android.graphics.Canvas canvas)` Called by the game engine thread to redraw all game objects.
`GameObject`	`getObjectByName(java.lang.String name)` Look up the first object that was registered with name `name`
`java.util.List<GameObject>`	`getObjectsMatching(java.lang.String prefix)` Return a list of all game objects whose names start with the given prefix.
`android.content.res.Resources`	`getResources()` Returns the cached resources object.
`float`	`getWorldScreenHeight()` Get the currently-configured world height in world units
`float`	`getWorldScreenWidth()` Get the currently-configured world width in world units
`void`	`handleMessage(Message msg)` Ignore this for now.
`boolean`	`isFullyOffScreen(GameObject obj)` Returns true if the object is entirely outside the boundaries of the screen at the object's current location.
`boolean`	`isFullyOnScreen(GameObject obj)` Returns true if the game object is entirely within the boundaries of the screen at the object's current location.
`void`	`onMotionEvent(GameView.UIEvent e)` Called by the game engine thread as events arrive.
`void`	`setLevel(GameLevel level)` Requests the game engine to move to a different game level after the current update/draw cycle is complete.
`void`	`setScene(Scene scene)` Set the scene to be used as a background starting on the next draw() cycle.
`void`	`setWorldScreenSize(float width, float height)` Sets the width and height of the game world in arbitrary units.
`void`	`update(int millis)` Called by the game engine thread to update all game objects.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - mBus
```
public MessageBus mBus
```
    An instance of the MessageBus that can be used to send messages, assuming we start using that feature again.
- Constructor Detail
  - GameObjectManager
```
public GameObjectManager(MessageBus mbus,
                         android.content.res.Resources res)
```
    Called by the game's main Activity to set up all the game logic.
    
    Parameters:
    
    mbus - MessageBus for passing messages between game objects and infrastructure
    
    res - pointer to the resources for this Activity so we can make them accesible to things that need them, in particular Sprite and BackgroundImageScene
- Method Detail
  - setLevel
```
public void setLevel(GameLevel level)
```
    Requests the game engine to move to a different game level after the current update/draw cycle is complete.
    
    Parameters:
    
    level - a subclass of GameLevel customized for your game
  - getResources
```
public android.content.res.Resources getResources()
```
    Returns the cached resources object.
    
    Returns:
    
    the resources associated with the Activity that this game is running with.
  - addObject
```
public void addObject(GameObject obj)
```
    Adds a GameObject or a subclass into the list of objects being managed.
    Objects in this list will have their update() and draw() routines called at regular intervals, and will receive UI events (taps, swipes) that are within their boundary.
    
    Parameters:
    
    obj - a GameObject or derived class to manage
  - getObjectByName
```
public GameObject getObjectByName(java.lang.String name)
```
    Look up the first object that was registered with name name
    
    Parameters:
    
    name - the name of the object to search for
    
    Returns:
    
    the object, if one was found; otherwise null.
  - getObjectsMatching
```
public java.util.List<GameObject> getObjectsMatching(java.lang.String prefix)
```
    Return a list of all game objects whose names start with the given prefix.
    For example, if you register game objects named orc1, orc2, orc3 then you could get a list of these objects by calling with prefix = "orc".
    
    Parameters:
    
    prefix - the string to match against the object names.
    
    Returns:
    
    a List containing zero or more game objects.
  - setScene
```
public void setScene(Scene scene)
```
    Set the scene to be used as a background starting on the next draw() cycle.
    If you want the background to just be a solid color, pass in an instance of SolidColorScene. If you want the background to be an image, pass in an instance of BackgroundImageScene.
    
    Parameters:
    
    scene - a subclass of Scene of the desired type
  - setWorldScreenSize
```
public void setWorldScreenSize(float width,
                               float height)
```
    Sets the width and height of the game world in arbitrary units.
    This method should be called once at the start of a level to set the desired size of the world for that level. Changing the world size after the level is running has undefined behavior.
    
    If you don't call this method, the default will be whatever size was configured by the previous level, or 1600x900 if it was never called. 1600x900 is a good choice if you don't have a reason to do otherwise.
    
    Parameters:
    
    width - width of the world in units
    
    height - height of the world in units
  - handleMessage
```
public void handleMessage(Message msg)
```
    Ignore this for now.
    
    Specified by:
    
    handleMessage in interface IMessageClient
    
    Parameters:
    
    msg -
  - onMotionEvent
```
public void onMotionEvent(GameView.UIEvent e)
```
    Called by the game engine thread as events arrive. Do not call this directly.
    
    Specified by:
    
    onMotionEvent in interface GameView.IGameLogicService
    
    Parameters:
    
    e - the event to deliver.
  - draw
```
public void draw(android.graphics.Canvas canvas)
```
    Called by the game engine thread to redraw all game objects. Do not call this directly.
    
    Specified by:
    
    draw in interface GameView.IRedrawService
    
    Parameters:
    
    canvas - the current canvas object associated with our SurfaceView
  - update
```
public void update(int millis)
```
    Called by the game engine thread to update all game objects. Do not call this directly.
    
    Specified by:
    
    update in interface GameView.IGameLogicService
    
    Parameters:
    
    millis - number of milliseconds since the last world update.
  - isFullyOnScreen
```
public boolean isFullyOnScreen(GameObject obj)
```
    Returns true if the game object is entirely within the boundaries of the screen at the object's current location.
    
    Parameters:
    
    obj - the game object to check for on-screen-ness
    
    Returns:
    
    true if the object is entirely on-screen
  - isFullyOffScreen
```
public boolean isFullyOffScreen(GameObject obj)
```
    Returns true if the object is entirely outside the boundaries of the screen at the object's current location.
    
    Parameters:
    
    obj - the game object to check for off-screen-ness
    
    Returns:
    
    true if the object is entirely off-screen
  - getWorldScreenWidth
```
public float getWorldScreenWidth()
```
    Get the currently-configured world width in world units
    
    Returns:
    
    the world width in world units
  - getWorldScreenHeight
```
public float getWorldScreenHeight()
```
    Get the currently-configured world height in world units
    
    Returns:
    
    the world height in world units

Class GameObjectManager

The central class of the game engine, responsible for keeping track of all the game objects helping them interact with the Android system.

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mBus

Constructor Detail

GameObjectManager

Method Detail

setLevel

getResources

addObject

getObjectByName

getObjectsMatching

setScene

setWorldScreenSize

handleMessage

onMotionEvent

draw

update

isFullyOnScreen

isFullyOffScreen

getWorldScreenWidth

getWorldScreenHeight