indigo

package indigo

Type members

Classlikes

final case class BootResult[A](gameConfig: GameConfig, bootData: A, animations: Set[Animation], assets: Set[AssetType], fonts: Set[FontInfo], subSystems: Set[SubSystem], shaders: Set[Shader])

The game bootstrapping process results in a BootResult, which only occurs once on initial game load. The boot result decribes all of the initial values of your game such as it's configuration, data, animations, assets, fonts, subsystems, and shaders. You can add additional assets, animations, fonts, and shaders later during the setup process, so it is recommended that you only load the bare minimum needed to get your game going during the boot phase.

The game bootstrapping process results in a BootResult, which only occurs once on initial game load. The boot result decribes all of the initial values of your game such as it's configuration, data, animations, assets, fonts, subsystems, and shaders. You can add additional assets, animations, fonts, and shaders later during the setup process, so it is recommended that you only load the bare minimum needed to get your game going during the boot phase.

Companion:
object
object BootResult
Companion:
class
trait GameLauncher[StartUpData, Model, ViewModel]
Companion:
object
Companion:
class
trait IndigoDemo[BootData, StartUpData, Model, ViewModel] extends GameLauncher[StartUpData, Model, ViewModel]

A trait representing a minimal set of functions to get your game running

A trait representing a minimal set of functions to get your game running

Type parameters:
BootData

The class type representing you a successful game boot up

Model

The class type representing your game's model

StartUpData

The class type representing your successful startup data

ViewModel

The class type representing your game's view model

Example:

object MyGame extends IndigoDemo[BootData, StartUpData, Model, ViewModel]

trait IndigoGame[BootData, StartUpData, Model, ViewModel] extends GameLauncher[StartUpData, Model, ViewModel]

A trait representing a game with scene management baked in

A trait representing a game with scene management baked in

Type parameters:
BootData

The class type representing you a successful game boot up

Model

The class type representing your game's model

StartUpData

The class type representing your successful startup data

ViewModel

The class type representing your game's view model

Example:

object MyGame extends IndigoGame[BootData, StartUpData, Model, ViewModel]

trait IndigoSandbox[StartUpData, Model] extends GameLauncher[StartUpData, Model, Unit]

A trait representing a minimal set of functions to get your game running

A trait representing a minimal set of functions to get your game running

Type parameters:
Model

The class type representing your game's model

StartUpData

The class type representing your successful startup data

Example:

object MyGame extends IndigoSandbox[StartUpData, Model]

object syntax

Types

type Blend = Blend
type Camera = Camera
type Clip[M <: Material] = Clip[M]
type Combo = Combo
type Cycle = Cycle
type Delete = Delete
type Depth = Depth
type Dice = Dice
type FPS = FPS
type Fill = Fill
type Flip = Flip
type Font = Font
type Frame = Frame
type FrameContext[StartUpData] = FrameContext[StartUpData]
type FrameTick = FrameTick.type
type Graphic[M <: Material] = Graphic[M]
type Group = Group
type Key = Key
type Layer = Layer
type Light = Light
type Load = Load
type Loaded = Loaded
type Millis = Millis
type Mouse = Mouse
type Outcome[T] = Outcome[T]
type Pixels = Pixels
type Point = Point
type RGB = RGB
type RGBA = RGBA
type Save = Save
type Shader = Shader
type Shape[T <: Shape[_]] = Shape[T]
type Signal[A] = Signal[A]
type SignalFunction[A, B] = SignalFunction[A, B]
type SignalReader[R, A] = SignalReader[R, A]
type SignalState[S, A] = SignalState[S, A]
type Size = Size
type Sprite[M <: Material] = Sprite[M]
type Startup[SuccessType] = Startup[SuccessType]
type Stroke = Stroke
type Text[M <: Material] = Text[M]
type Track = Track
type Volume = Volume
type Zoom = Zoom
type array[T] = array[T]
type float = float
type mat4 = mat4
type vec2 = vec2
type vec3 = vec3
type vec4 = vec4

Value members

Concrete fields

val AccessControl: AccessControl.type
val AnimationAction: AnimationAction.type
val Aseprite: Aseprite.type
val AssetBatchLoadError: AssetBatchLoadError.type
val AssetBatchLoaded: AssetBatchLoaded.type
val AssetTag: AssetTag.type
val Blend: Blend.type
val BlendFactor: BlendFactor.type
val Blending: Blending.type
val Camera: Camera.type
val Clip: Clip.type
val CloneId: CloneId.type
val Combo: Combo.type
val Cycle: Cycle.type
val Delete: Delete.type
val Depth: Depth.type
val Dice: Dice.type
val FPS: FPS.type
val Falloff: Falloff.type
val Fill: Fill.type
val FillType: FillType.type
val Flip: Flip.type
val Font: Font.type
val FontChar: FontChar.type
val FontInfo: FontInfo.type
val FontKey: FontKey.type
val FontStyle: FontStyle.type
val FontVariant: FontVariant.type
val FontWeight: FontWeight.type
val Frame: Frame.type
val GameTime: GameTime.type
val Gamepad: Gamepad.type
val GamepadInput: GamepadInput.type
val Graphic: Graphic.type
val Group: Group.type
val HttpResponse: HttpResponse.type
val Key: Key.type
val Keyboard: Keyboard.type
val Layer: Layer.type
val Load: Load.type
val LoadAsset: LoadAsset.type
val LoadAssetBatch: LoadAssetBatch.type
val Loaded: Loaded.type
val Material: Material.type
val Matrix3: Matrix3.type
val Matrix4: Matrix4.type
val Millis: Millis.type
val Mouse: Mouse.type
val MouseWheel: MouseWheel.type
val Mutants: Mutants.type
val Outcome: Outcome.type
val Pixels: Pixels.type
val PlaySound: PlaySound.type
val PlaybackPattern: PlaybackPattern.type
val Point: Point.type
val RGB: RGB.type
val RGBA: RGBA.type
val Radians: Radians.type
val RendererDetails: RendererDetails.type
val Save: Save.type
val Seconds: Seconds.type
val ShaderId: ShaderId.type
val Shape: Shape.type
val Signal: Signal.type
val Size: Size.type
val Sprite: Sprite.type
val SpriteAndAnimations: SpriteAndAnimations.type
val Startup: Startup.type
val Stroke: Stroke.type
val Text: Text.type
val TextAlign: TextAlign.type
val TextAlignment: TextAlignment.type
val TextBaseLine: TextBaseLine.type
val TextBox: TextBox.type
val TextDirection: TextDirection.type
val TextStroke: TextStroke.type
val Texture: Texture.type
val TiledGridCell: TiledGridCell.type
val TiledGridLayer: TiledGridLayer.type
val TiledGridMap: TiledGridMap.type
val TiledMap: TiledMap.type
val Track: Track.type
val Uniform: Uniform.type
val UniformBlock: UniformBlock.type
val Vector2: Vector2.type
val Vector3: Vector3.type
val Vector4: Vector4.type
val ViewportResize: ViewportResize.type
val Volume: Volume.type
val WebSocketConfig: WebSocketConfig.type
val WebSocketId: WebSocketId.type
val Zoom: Zoom.type
val array: array.type

defaultGameConfig Provides a useful default config set up:

defaultGameConfig Provides a useful default config set up:

  • Game Viewport = 550 x 400
  • FPS = 30
  • Clear color = Black
  • Magnification = 1
  • No advanced settings enabled
Returns:

A GameConfig instance

val float: float.type
val mat4: mat4.type

noRender Convenience value, alias for SceneUpdateFragment.empty

noRender Convenience value, alias for SceneUpdateFragment.empty

Returns:

An Empty SceneUpdateFragment

val rawArray: rawArray.type
val vec2: vec2.type
val vec3: vec3.type
val vec4: vec4.type