Interface EngineDevice

public interface EngineDevice
Describes a device started by the engine after object creation and configuration script execution.

The Ordering annotation can influence invocation order on this type of object.

Author:
Matthew Tropiano

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    createDevice()
    Creates this device.
    boolean
    destroyDevice()
    Destroys this device.
    String
    getDeviceName()
    Gets a friendlier name for this device.
    boolean
    isDeviceActive()
    Checks if this device was "created" and can be destroyed.

  • Method Details

    • getDeviceName

      String getDeviceName()
      Gets a friendlier name for this device. This cannot return null.
      Returns:
      the "friendly" name for the device.

    • isDeviceActive

      boolean isDeviceActive()
      Checks if this device was "created" and can be destroyed.
      Returns:
      true if so, false if not.

    • createDevice

      boolean createDevice()
      Creates this device.

      This is called (AND SHOULD ONLY BE CALLED) by the Engine after component singletons are created and the heavyweight devices (Graphics, Sound, ... etc) need creating.

      Returns:
      true if created successfully, false if not.

    • destroyDevice

      boolean destroyDevice()
      Destroys this device.

      This is called (AND SHOULD ONLY BE CALLED) by the Engine when this device is restarted or the engine is shutting down.

      Returns:
      true if destroyed successfully, false if not.