IndigoProject
API
Generated with
IndigoProject/indigo/indigo.shared

indigo.shared

package indigo.shared

Members list

Packages

package indigo.shared.animation
package indigo.shared.assets
package indigo.shared.audio
package indigo.shared.collections
package indigo.shared.config
package indigo.shared.constants
package indigo.shared.datatypes
package indigo.shared.dice
package indigo.shared.display
package indigo.shared.events
package indigo.shared.formats
package indigo.shared.geometry
package indigo.shared.input
package indigo.shared.materials
package indigo.shared.networking
package indigo.shared.platform
package indigo.shared.scenegraph
package indigo.shared.shader
package indigo.shared.subsystems
package indigo.shared.temporal
package indigo.shared.time
package indigo.shared.trees
package indigo.shared.utils

Type members

Classlikes

final class AnimationsRegister

Attributes

Supertypes
class Object
trait Matchable
class Any
final class BoundaryLocator(animationsRegister: AnimationsRegister, fontRegister: FontRegister, dynamicText: DynamicText)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object BoundaryLocator

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object CacheKey

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
CacheKey.type
final class FontRegister

Attributes

Supertypes
class Object
trait Matchable
class Any
final class FrameContext[StartUpData](val gameTime: GameTime, val dice: Dice, val inputState: InputState, val boundaryLocator: BoundaryLocator, _startUpData: => StartUpData)

The FrameContext is the context in which the current frame will be processed. In includes values that are unique to this frame, and also globally available services.

The FrameContext is the context in which the current frame will be processed. In includes values that are unique to this frame, and also globally available services.

Value parameters

boundaryLocator

A service that can be interrogated for the calculated dimensions of screen elements.

dice

A pseudo-random number generator, made predictable / reproducible by being seeded on the current running time.

gameTime

A sampled instance of time that you should use everywhere that you need a time value.

inputState

A snapshot of the state of the various input methods, also allows input mapping of combinations of inputs.

startUpData

A read only reference to any and all data created during start up / set up.

Attributes

Supertypes
class Object
trait Matchable
class Any
object IndigoLogger

A very, very simple logger that logs to the Browsers console with a few standard headers and the log message.

A very, very simple logger that logs to the Browsers console with a few standard headers and the log message.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait JsonSupportFunctions

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Json
sealed trait Outcome[+A]

An Outcome represents the result of some part of a frame update. It contains a value or an error (exception), and optionally a list of events to be processed on the next frame.

An Outcome represents the result of some part of a frame update. It contains a value or an error (exception), and optionally a list of events to be processed on the next frame.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Error
class Result[A]
object Outcome

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Outcome.type
sealed trait PowerOfTwo

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object _1024
object _128
object _16
object _2
object _2048
object _256
object _32
object _4
object _4096
object _512
object _64
object _8
Show all
object PowerOfTwo

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
PowerOfTwo.type
final class QuickCache[A](cache: Dictionary[A])

QuickCache is a handy way to avoid expensive re-calculation of data. It is a side-effecting arrangement that Indigo uses a lot internally, that can also be used by cautious game devs. Simple example:

QuickCache is a handy way to avoid expensive re-calculation of data. It is a side-effecting arrangement that Indigo uses a lot internally, that can also be used by cautious game devs. Simple example:

given QuickCache[MyExpensiveObject] = QuickCache.empty

QuickCache("key")(obj)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object QuickCache

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
QuickCache.type
sealed trait Startup[+SuccessType] extends Product, Serializable

The Startup data type describes either a successful or failed start up sequence. It can hold a value, as well as new shaders, animations and fonts to be added to Indigo's registers. A new Startup instance is created each time the setup function is called, at least once, but also on dynamic asset load.

The Startup data type describes either a successful or failed start up sequence. It can hold a value, as well as new shaders, animations and fonts to be added to Indigo's registers. A new Startup instance is created each time the setup function is called, at least once, but also on dynamic asset load.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Failure
class Success[SuccessType]
object Startup

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Startup.type
trait ToCacheKey[A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ToCacheKey

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
ToCacheKey.type

Types

opaque type CacheKey
Generated with