Index

A B C D E F G H I K L M N O P Q R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Activatable - Interface in com.github.hanyaeger.core
Implementing Activatable denotes the Object can, and usually must, be activated before it can be used.
activate() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
 
activate() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
activate() - Method in class com.github.hanyaeger.api.scenes.TileMap
 
activate() - Method in interface com.github.hanyaeger.core.Activatable
Lifecycle method used to perform activation of this Game Object.
add(Coordinate2D) - Method in class com.github.hanyaeger.api.Coordinate2D
Returns a Coordinate2D with the coordinates of the specified point added to the coordinates of this Coordinate2D.
add(Point2D) - Method in class com.github.hanyaeger.api.Coordinate2D
 
addBoundingBoxVisualizer(BoundingBoxVisualizer) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Add a BoundingBoxVisualizer to this EntityCollection.
addDynamicEntity(Updatable) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Add a Dynamic Entity to this EntityCollection.
addEntity(int, Class<? extends YaegerEntity>) - Method in class com.github.hanyaeger.api.scenes.TileMap
Add the Class of an SpriteEntity that can be used in this TileMap.
addEntity(int, Class<? extends YaegerEntity>, C) - Method in class com.github.hanyaeger.api.scenes.TileMap
Add the Class of an SpriteEntity that can be used in this TileMap.
addEntity(YaegerEntity) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
Add an YaegerEntity to this YaegerScene.
addEntity(YaegerEntity) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Add an YaegerEntity to this YaegerScene.
addEntity(YaegerEntity, boolean) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Add an YaegerEntity to this YaegerScene.
addEntitySpawner(EntitySpawner) - Method in interface com.github.hanyaeger.api.EntitySpawnerContainer
Use this method to add any EntitySpawner that is required by the YaegerScene.
addRemoveHandler(EventHandler) - Method in class com.github.hanyaeger.core.entities.motion.InitializationBuffer
Add a EventHandler that should be registered for EventTypes.REMOVE when the Node has been set.
addScene(int, YaegerScene) - Method in class com.github.hanyaeger.api.YaegerGame
Add a YaegerScene to the Game.
addScene(int, YaegerScene) - Method in class com.github.hanyaeger.core.SceneCollection
Add a YaegerScene to the collection of SceneCollection.
addScene(int, YaegerScene) - Method in class com.github.hanyaeger.core.YaegerStage
Add a YaegerScene to the YaegerStage.
addSimplePhysics() - Method in interface com.github.hanyaeger.api.entities.Newtonian
Return an Updatable that applies simple rules of physics on each call to Updatable.update(long).
addStaticEntity(YaegerEntity) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Add a Static Entity to this EntityCollection.
addStatisticsObserver(StatisticsObserver) - Method in class com.github.hanyaeger.core.entities.EntityCollection
addTileMap(TileMap) - Method in interface com.github.hanyaeger.api.scenes.TileMapContainer
Register an TileMap.
addTimer(Timer) - Method in interface com.github.hanyaeger.api.TimerContainer
Use this method to add any Timer that is required by the YaegerScene or YaegerEntity in which it is instantiated.
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
addToEntityCollection(EntityCollection) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Add this YaegerEntity to the EntityCollection, which will make it part of the YaegerGame.
addToMotion(double, double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
addToMotion(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Add a given motion to the current motion.
addToMotion(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
addToMotion(double, Direction) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
addToMotion(double, Direction) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Add a given motion to the current motion.
addToMotion(double, Direction) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
addToParent(EntityProcessor) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
Note that this method will become recursive if the composition consists of more instance of CompositeEntity.
addToParent(EntityProcessor) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
The Node encapsulated by this YaegerEntity should be added to a parent Node to be displayed on the screen and become part of the YaegerScene.
addUpdatable(Updatable) - Method in class com.github.hanyaeger.core.Updater
Add an Updatable to this Updater.
addUpdatable(Updatable, boolean) - Method in class com.github.hanyaeger.core.Updater
Add an Updatable to this Updater.
Anchorable - Interface in com.github.hanyaeger.core.entities
When an YaegerEntity is Anchorable, it has access to am anchorpoint.
AnchorPoint - Enum Class in com.github.hanyaeger.api
An AnchorPoint denotes the point of an YaegerEntity which is being used for placement on the x,y-coordinate.
angleTo(Coordinate2D) - Method in class com.github.hanyaeger.api.Coordinate2D
Returns a double with the angle to the specified point of this Coordinate2D
angleTo(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Computes the angle (in degrees) between the unit vector that originates at the YaegerEntity.getAnchorLocation() of this YaegerEntity and the vector with its origin at that same YaegerEntity.getAnchorLocation() that points towards the specified Coordinate2D.
angleTo(YaegerEntity) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Computes the angle (in degrees) between the unit vector that originates at the YaegerEntity.getAnchorLocation() point of this YaegerEntity and the vector with its origin at that same YaegerEntity.getAnchorLocation() that points towards the YaegerEntity.getAnchorLocation() of the specified YaegerEntity.
Animation - Interface in com.github.hanyaeger.api.entities
An Animation encapsulate an animation that uses only a selection of the frames from a sprite sheet.
AnimationCallback - Interface in com.github.hanyaeger.api.entities
When used with an Animation that support a callback, this interface should be implemented by the object that supplies the callback-method.
AnimationTimerFactory - Class in com.github.hanyaeger.core.factories.animationtimer
An AnimationTimerFactory should be used to create instances of an AnimationTimer.
AnimationTimerFactory() - Constructor for class com.github.hanyaeger.core.factories.animationtimer.AnimationTimerFactory
 
AnimationTimerHandler - Interface in com.github.hanyaeger.core.factories.animationtimer
A Functional Interface to be used for the default handler of a AnimationTimer.
AnnotationProcessor - Class in com.github.hanyaeger.core.annotations
The AnnotationProcessor is responsible for processing Yaeger specific annotations.
AnnotationProcessor() - Constructor for class com.github.hanyaeger.core.annotations.AnnotationProcessor
 
applyEntityProcessor(EntityProcessor) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
applyEntityProcessor(EntityProcessor) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Apply an EntityProcessor to this YaegerEntity.
applyRotation() - Method in interface com.github.hanyaeger.api.entities.ContinuousRotatable
Return an Updatable that applies the rotation on each Updatable.update(long).
applyTranslationsForAnchorPoint() - Method in class com.github.hanyaeger.api.entities.CompositeEntity
At this stage we only ask the children to apply their transformation.
applyTranslationsForAnchorPoint() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
A YaegerEntity's location is defined by its anchorLocation and its anchorPoint.
applyTranslationsForAnchorPoint() - Method in class com.github.hanyaeger.core.entities.CenteredShapeEntity
 
asFirst() - Element in annotation interface com.github.hanyaeger.core.annotations.UpdatableProvider
State whether the Updatable returned by the method annotated with this annotation should be added to the front of the list of instances of Updatable.
attachDragEnteredListener() - Method in interface com.github.hanyaeger.api.userinput.MouseDragEnterListener
Attach a MouseDragEnterListener to this YaegerEntity or YaegerScene.
attachDragExitedListener() - Method in interface com.github.hanyaeger.api.userinput.MouseDragExitedListener
Attach a MouseDragExitedListener to this YaegerEntity or YaegerScene.
attachDropListener() - Method in interface com.github.hanyaeger.api.userinput.MouseDropListener
attachEventListener(EventType<T>, EventHandler<T>) - Method in interface com.github.hanyaeger.core.entities.EventInitiator
Attach an EventHandler for the given EventType.
attachEventListener(EventType, EventHandler) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
attachEventListener(EventType, EventHandler) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
attachMouseButtonPressedListener() - Method in interface com.github.hanyaeger.api.userinput.MouseButtonPressedListener
Attach a mousePressedListener to this YaegerEntity or YaegerScene.
attachMouseButtonReleasedListener() - Method in interface com.github.hanyaeger.api.userinput.MouseButtonReleasedListener
attachMouseDraggedListener() - Method in interface com.github.hanyaeger.api.userinput.MouseDraggedListener
Attach a MouseDraggedListener to this YaegerEntity or YaegerScene.
attachMouseEnterListener() - Method in interface com.github.hanyaeger.api.userinput.MouseEnterListener
attachMouseExitListener() - Method in interface com.github.hanyaeger.api.userinput.MouseExitListener
attachMouseMovedListener() - Method in interface com.github.hanyaeger.api.userinput.MouseMovedListener
Attach a mouse moved Listener to this entity.
attachMouseMovedWhileDraggedListener() - Method in interface com.github.hanyaeger.api.userinput.MouseMovedWhileDraggingListener
Attach a mouse moved while dragged Listener to this entity.
AudioRepository - Class in com.github.hanyaeger.core.repositories
An AudioRepository provides a central repository for acquiring audio files.

B

BackgroundAudioMediaPlayer - Class in com.github.hanyaeger.core.media
A MediaPlayer for playing background audio.
BackgroundAudioMediaPlayer() - Constructor for class com.github.hanyaeger.core.media.BackgroundAudioMediaPlayer
 
BackgroundDelegate - Class in com.github.hanyaeger.core.scenes.delegates
A BackgroundDelegate follows the Delegate pattern and embraces Composition over Inheritance.
BackgroundDelegate() - Constructor for class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
 
BackgroundFactory - Class in com.github.hanyaeger.core.factories
A BackgroundFactory can be used to create instances of Background to be used as the background of a Pane.
BackgroundFactory() - Constructor for class com.github.hanyaeger.core.factories.BackgroundFactory
 
beforeInitialize() - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
beforeInitialize() - Method in interface com.github.hanyaeger.core.Initializable
A default method to be used as a lifecycle hook to be called before a YaegerEntity is initialized and added to the YaegerScene.
BOTTOM - Enum constant in enum class com.github.hanyaeger.api.scenes.SceneBorder
The top of the YaegerScene.
BOTTOM_CENTER - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the bottom-center point of the bounding box as the Anchor Point.
BOTTOM_LEFT - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the bottom-left corner of the bounding box as the Anchor Point.
BOTTOM_RIGHT - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the bottom-right corner of the bounding box as the Anchor Point.
Bounded - Interface in com.github.hanyaeger.core.entities
Implementing this interface exposes the Bounded.getBoundingBox() and method, which returns the bounds, aka Bounding Box, of this Entity.
BufferedMovable - Interface in com.github.hanyaeger.core.entities.motion
A BufferedMovable extends the interface Movable and support the use of a buffer.

C

call() - Method in interface com.github.hanyaeger.api.entities.AnimationCallback
Method to be implemented to handle the callback.
callback() - Method in interface com.github.hanyaeger.api.entities.Animation
The AnimationCallback is a functional interface the method AnimationCallback.call(), which will be called after the animation calls the last sprite.
callback() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns the value of the callback record component.
callback() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the callback record component.
callEntitySpawners() - Method in interface com.github.hanyaeger.api.EntitySpawnerContainer
Call the Updatable.update(long) of all instances of EntitySpawner that were added to this EntitySpawnerContainer.
callTimers() - Method in interface com.github.hanyaeger.api.TimerContainer
Return an Updatable that, when called, call all the timers that were added to this TimerContainer.
CENTER_CENTER - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the center point of the bounding box as the Anchor Point.
CENTER_LEFT - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the center-left point of the bounding box as the Anchor Point.
CENTER_RIGHT - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the center-right point of the bounding box as the Anchor Point.
CenteredShapeEntity<T> - Class in com.github.hanyaeger.core.entities
A CenteredShapeEntity is a special case of a ShapeEntity, based on a Shape of which the center is the reference point when placed on a Scene.
CenteredShapeEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.core.entities.CenteredShapeEntity
Instantiate a new CenteredShapeEntity for the given Coordinate2D.
changeDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
changeDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Change the direction by adding a rotation in degrees.
changeDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
checkCollisions() - Method in class com.github.hanyaeger.core.entities.CollisionDelegate
Check for collisions.
checkForCollisions(List<Collider>) - Method in interface com.github.hanyaeger.api.entities.Collided
Perform collision detection with a Set of Collider instances.
CircleEntity - Class in com.github.hanyaeger.api.entities.impl
A CircleEntity provides the option to use a drawable Circle as an YaegerEntity.
CircleEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.CircleEntity
Create a new CircleEntity on the given initialLocation.
clear() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
clear() - Method in interface com.github.hanyaeger.core.Clearable
Implement this method and use it to clear the content of this Object.
clear() - Method in class com.github.hanyaeger.core.entities.EntityCollection
Clear this EntityCollection.
clear() - Method in class com.github.hanyaeger.core.repositories.DragNDropRepository
Clear the content of this repository.
clear() - Method in class com.github.hanyaeger.core.Updater
 
Clearable - Interface in com.github.hanyaeger.core
Denote that this Object can be cleared.
Collided - Interface in com.github.hanyaeger.api.entities
A Collided is a YaegerEntity that can be collided with by a Collider.
Collider - Interface in com.github.hanyaeger.api.entities
A Collider represents an YaegerEntity that can be collided with by a Collided
CollisionDelegate - Class in com.github.hanyaeger.core.entities
A CollisionDelegate handles all behavior related to Object collisions.
CollisionDelegate() - Constructor for class com.github.hanyaeger.core.entities.CollisionDelegate
Create a new CollisionDelegate.
colorAdjust - Variable in class com.github.hanyaeger.core.YaegerGameObject
The ColorAdjust, which is responsible for setting the effects on the Node.
columnEnd() - Method in interface com.github.hanyaeger.api.entities.Animation
The column-index of the last sprite to be shown.
columnEnd() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns the value of the columnEnd record component.
columnEnd() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns the value of the columnEnd record component.
columnEnd() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns the value of the columnEnd record component.
columnEnd() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the columnEnd record component.
columnEnd() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns the value of the columnEnd record component.
columnStart() - Method in interface com.github.hanyaeger.api.entities.Animation
The column-index of the first sprite to be shown.
columnStart() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns the value of the columnStart record component.
columnStart() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns the value of the columnStart record component.
columnStart() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns the value of the columnStart record component.
columnStart() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the columnStart record component.
columnStart() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns the value of the columnStart record component.
com.github.hanyaeger.api - package com.github.hanyaeger.api
Classes and packages that are part of the public API of Yaeger.
com.github.hanyaeger.api.entities - package com.github.hanyaeger.api.entities
All classes, interfaces and enumerations that are related to entities and their behaviour.
com.github.hanyaeger.api.entities.impl - package com.github.hanyaeger.api.entities.impl
All (abstract) implementations of YaegerEntity that can be used on a YaegerScene.
com.github.hanyaeger.api.media - package com.github.hanyaeger.api.media
Classes required for creating media objects.
com.github.hanyaeger.api.scenes - package com.github.hanyaeger.api.scenes
All classes, interfaces and enumerations that are related to scenes.
com.github.hanyaeger.api.userinput - package com.github.hanyaeger.api.userinput
All interfaces that enable an instance of YaegerEntity, YaegerScene or both to receive user input.
com.github.hanyaeger.core - package com.github.hanyaeger.core
 
com.github.hanyaeger.core.annotations - package com.github.hanyaeger.core.annotations
 
com.github.hanyaeger.core.entities - package com.github.hanyaeger.core.entities
 
com.github.hanyaeger.core.entities.motion - package com.github.hanyaeger.core.entities.motion
 
com.github.hanyaeger.core.factories - package com.github.hanyaeger.core.factories
 
com.github.hanyaeger.core.factories.animationtimer - package com.github.hanyaeger.core.factories.animationtimer
 
com.github.hanyaeger.core.factories.debug - package com.github.hanyaeger.core.factories.debug
 
com.github.hanyaeger.core.factories.image - package com.github.hanyaeger.core.factories.image
 
com.github.hanyaeger.core.media - package com.github.hanyaeger.core.media
 
com.github.hanyaeger.core.repositories - package com.github.hanyaeger.core.repositories
 
com.github.hanyaeger.core.scenes.delegates - package com.github.hanyaeger.core.scenes.delegates
 
com.github.hanyaeger.core.scenes.splash - package com.github.hanyaeger.core.scenes.splash
 
CompositeEntity - Class in com.github.hanyaeger.api.entities
When a group of entities is combined to create a single YaegerEntity, they are a composition and this class should be used to perform that composition.
CompositeEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.CompositeEntity
Create a new CompositeEntity on the given initialLocation.
configureUpdateDelegators(Object) - Method in class com.github.hanyaeger.core.annotations.AnnotationProcessor
When calling this method, the Object provided als its parameter will be scanned for the annotation UpdatableProvider, if the Object is an UpdateDelegator.
ContinuousRotatable - Interface in com.github.hanyaeger.api.entities
When implementing this Interface, a YaegerEntity will acquire the behaviour to perform a rotation on each Game World update, and thus give the illusion of a continuous rotation.
Coordinate2D - Class in com.github.hanyaeger.api
A Coordinate2D is a 2D geometric point that represents a pair of coordinates.
Coordinate2D() - Constructor for class com.github.hanyaeger.api.Coordinate2D
Creates a new instance of Coordinate2D at (0,0).
Coordinate2D(double, double) - Constructor for class com.github.hanyaeger.api.Coordinate2D
Creates a new instance of Coordinate2D.
Coordinate2D(Point2D) - Constructor for class com.github.hanyaeger.api.Coordinate2D
Creates a new instance of a Coordinate2D.
CoordinateGridDelegate - Class in com.github.hanyaeger.core.scenes.delegates
A CoordinateGridDelegate follows the Delegate pattern and embraces Composition over Inheritance.
CoordinateGridDelegate() - Constructor for class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
 
create() - Method in class com.github.hanyaeger.core.factories.debug.DebugGridPaneFactory
Construct a new GridPane that can be used by the Debugger.
create(EntityConfiguration<C>, Coordinate2D, Size) - Method in class com.github.hanyaeger.core.factories.TileFactory
Create an instance of YaegerEntity with an EntityConfiguration of the given type TileFactory with the given parameters.
create(AnimationTimerHandler, boolean) - Method in class com.github.hanyaeger.core.factories.animationtimer.AnimationTimerFactory
Create an AnimationTimer with the given handler.
create(YaegerConfig) - Method in class com.github.hanyaeger.core.factories.EntityCollectionFactory
create(Class<? extends YaegerEntity>, Coordinate2D, Size) - Method in class com.github.hanyaeger.core.factories.TileFactory
Create an instance of YaegerEntity with the given parameters.
create(Runnable) - Method in class com.github.hanyaeger.core.scenes.splash.SplashScreenFactory
Create an instance of SplashScene.
create(String) - Method in class com.github.hanyaeger.core.factories.image.ImageFactory
Constructs an Image with content loaded from the specified url.
create(String, double, double, boolean) - Method in class com.github.hanyaeger.core.factories.image.ImageFactory
Construct a new Image with the specified parameters.
create(Image) - Method in class com.github.hanyaeger.core.factories.image.ImageViewFactory
Constructs an ImageView for the given Image.
create(ImageView, int, int) - Method in class com.github.hanyaeger.core.factories.image.SpriteAnimationDelegateFactory
Create a new SpriteAnimationDelegate for the given ImageView and number of rows and columns.
create(Pane) - Method in class com.github.hanyaeger.core.factories.EntitySupplierFactory
Create an instance of EntitySupplier with the given Pane.
create(Parent) - Method in class com.github.hanyaeger.core.factories.SceneFactory
Create a Scene.
create(Stage, YaegerConfig) - Method in class com.github.hanyaeger.core.factories.SceneCollectionFactory
Create a SceneCollection.
createEmptyForSize(Size) - Method in class com.github.hanyaeger.core.factories.SceneFactory
Create an empty Scene with the given Size
createFillBackground(Color) - Method in class com.github.hanyaeger.core.factories.BackgroundFactory
Create a Background with the specified fill Color.
createImageBackground(Image, boolean) - Method in class com.github.hanyaeger.core.factories.BackgroundFactory
Create a Background with the specified image.
createLabel(String) - Method in class com.github.hanyaeger.core.factories.debug.DebugLabelFactory
Instantiate a new DebugLabelFactory without any text value shown.
createLine(double, double, double, double, double, Color) - Method in class com.github.hanyaeger.core.factories.LineFactory
 
createMedia(String) - Static method in class com.github.hanyaeger.core.factories.MediaFactory
Constructs Media with content loaded from the specified url.
createMediaPlayer(Media) - Static method in class com.github.hanyaeger.core.factories.MediaFactory
Construct a new Image with the specified parameters.
createPane() - Method in class com.github.hanyaeger.core.factories.PaneFactory
Return an instance of Pane.
createPathForResource(String) - Method in interface com.github.hanyaeger.core.ResourceConsumer
Returns the absolute path for a given Resource.
createScrollPane() - Method in class com.github.hanyaeger.core.factories.PaneFactory
Return an instance of ScrollPane.
createStackPane() - Method in class com.github.hanyaeger.core.factories.PaneFactory
Return an instance of StackPane.
createText(String, Color) - Method in class com.github.hanyaeger.core.factories.TextFactory
 
createTimeableAnimationTimer(TimeableAnimationTimerHandler, long) - Method in class com.github.hanyaeger.core.factories.animationtimer.AnimationTimerFactory
Create an AnimationTimer with the given handler for the given interval.
createValue() - Method in class com.github.hanyaeger.core.factories.debug.DebugLabelFactory
Create a Label that can be used to display a value on the Debugger.
createValue(String) - Method in class com.github.hanyaeger.core.factories.debug.DebugLabelFactory
Create a Label that can be used to display a value on the Debugger.
CustomFont - Record Class in com.github.hanyaeger.api.entities.impl
Although many fonts are already available through the underlying technology JavaFX, it is also possible to use custom fonts.
CustomFont(String, double) - Constructor for record class com.github.hanyaeger.api.entities.impl.CustomFont
Create a new Custom Font for the given font file.
cycleTimeInMs() - Method in interface com.github.hanyaeger.api.entities.Animation
The interval for sprite cycling that will be used when playing this Animation.
cycleTimeInMs() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns the value of the cycleTimeInMs record component.
cycleTimeInMs() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns the value of the cycleTimeInMs record component.
cycleTimeInMs() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns the value of the cycleTimeInMs record component.
cycleTimeInMs() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the cycleTimeInMs record component.
cycleTimeInMs() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns the value of the cycleTimeInMs record component.

D

Debugger - Class in com.github.hanyaeger.core.entities
The Debugger is used to gather and show in-game debug information.
Debugger() - Constructor for class com.github.hanyaeger.core.entities.Debugger
 
DebugGridPaneFactory - Class in com.github.hanyaeger.core.factories.debug
A DebugGridPaneFactory should be used for creating instances of GridPane for use in the Debugger.
DebugGridPaneFactory() - Constructor for class com.github.hanyaeger.core.factories.debug.DebugGridPaneFactory
 
DebugLabelFactory - Class in com.github.hanyaeger.core.factories.debug
A value shown in the Debugger.
DebugLabelFactory() - Constructor for class com.github.hanyaeger.core.factories.debug.DebugLabelFactory
 
DEFAULT_AUTOCYCLE_INTERVAL - Static variable in interface com.github.hanyaeger.api.entities.Animation
The default interval for sprite cycling that will be used if none is set.
DEFAULT_FRICTION_CONSTANT - Static variable in class com.github.hanyaeger.core.entities.motion.MotionApplier
The default value to be used for the Friction constant, if none are set.
DEFAULT_GAME_DIMENSIONS - Static variable in class com.github.hanyaeger.api.YaegerGame
As an ode to the old days, the default dimensions of a Yaeger Game is 640x480px.
DEFAULT_GRAVITATIONAL_CONSTANT - Static variable in class com.github.hanyaeger.core.entities.motion.MotionApplier
The default value to be used for the Gravitational constant, if none are set.
DEFAULT_GRAVITATIONAL_DIRECTION - Static variable in class com.github.hanyaeger.core.entities.motion.MotionApplier
The default value to be used for the Gravitational direction, if none are set.
defineMap() - Method in class com.github.hanyaeger.api.scenes.TileMap
The lifecycle method defineMap() should be used to define the map that should be used.
DependencyInjector - Interface in com.github.hanyaeger.core
Implementing this interface states that this Object requires injection of dependencies.
destroy() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
 
destroy() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
destroy() - Method in interface com.github.hanyaeger.core.Destroyable
Implement this method and use it to ensure that the maximum number of Objects are eligible for Garbage Collection after this method has been called.
destroy() - Method in class com.github.hanyaeger.core.media.BackgroundAudioMediaPlayer
 
destroy() - Method in class com.github.hanyaeger.core.repositories.AudioRepository
 
destroy() - Method in class com.github.hanyaeger.core.repositories.ImageRepository
 
destroy() - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
 
destroy() - Method in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
 
Destroyable - Interface in com.github.hanyaeger.core
Denote that this Object is Destroyable and hence ensures maximum Objects eligible for Garbage Collection.
Direction - Enum Class in com.github.hanyaeger.api.entities
Convenience enum for setting the Direction.
DirectionProvider - Interface in com.github.hanyaeger.core.entities.motion
A DirectionProvider exposes a method to acquire the direction.
distanceTo(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Calculates the distance between the AnchorPoint of this YaegerEntity and the given Coordinate2D.
distanceTo(YaegerEntity) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Calculates the distance to a given YaegerEntity.
divide(Coordinate2D) - Method in class com.github.hanyaeger.api.Coordinate2D
Return a Coordinate2D with the coordinates of the specified point divided by the coordinates of this Coordinate2D.
DOWN - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The downward direction, of which the numeric value is 0 degrees.
DOWN_LEFT - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The diagonal direction to the left down, of which the numeric value is 315 degrees.
DOWN_RIGHT - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The diagonal direction to the right down, of which the numeric value is 45 degrees.
DragNDropRepository - Class in com.github.hanyaeger.core.repositories
The DragNDropRepository is responsible for storing the Object that is currently being dragged.
DragNDropRepository() - Constructor for class com.github.hanyaeger.core.repositories.DragNDropRepository
 
DragRepositoryAccessor - Interface in com.github.hanyaeger.core.entities
A DragRepositoryAccessor needs access to a DragNDropRepository to either set or get information about the object that is currently being dragged/dropped.
DynamicCircleEntity - Class in com.github.hanyaeger.api.entities.impl
An DynamicCircleEntity extends all behaviour of a CircleEntity, but also implements the Updatable Interface.
DynamicCircleEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
Create a new DynamicCircleEntity on the given initialLocation.
DynamicCompositeEntity - Class in com.github.hanyaeger.api.entities
When a group of entities is combined to create a single entity, they are a composition and this class should be used to perform that composition.
DynamicCompositeEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.DynamicCompositeEntity
Create a new DynamicCompositeEntity on the given initialLocation.
DynamicEllipseEntity - Class in com.github.hanyaeger.api.entities.impl
An DynamicEllipseEntity extends all behaviour of a EllipseEntity, but also implements the Updatable Interface.
DynamicEllipseEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
Create a new DynamicEllipseEntity on the given initialLocation.
DynamicEllipseEntity(Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
Create a new EllipseEntity on the given initialPosition with the given Size.
DynamicRectangleEntity - Class in com.github.hanyaeger.api.entities.impl
An DynamicRectangleEntity extends all behaviour of a RectangleEntity, but also implements the Updatable Interface.
DynamicRectangleEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
Create a new DynamicRectangleEntity on the given initialLocation.
DynamicRectangleEntity(Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
Create a new DynamicRectangleEntity on the given initialPosition with the given Size.
DynamicScene - Class in com.github.hanyaeger.api.scenes
A DynamicScene extends a StaticScene, but adds a Game World Update (GWU).
DynamicScene() - Constructor for class com.github.hanyaeger.api.scenes.DynamicScene
 
DynamicSpriteEntity - Class in com.github.hanyaeger.api.entities.impl
A DynamicSpriteEntity extends all behaviour of a SpriteEntity, but also implements the Updatable Interface.
DynamicSpriteEntity(String, Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Create a new DynamicSpriteEntity for the given image resource on the given initialLocation.
DynamicSpriteEntity(String, Coordinate2D, int, int) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Create a new DynamicSpriteEntity for the given image resource on the given Coordinate2D.
DynamicSpriteEntity(String, Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Create a new DynamicSpriteEntity for the given image resource on the given Coordinate2D, with the given Size.
DynamicSpriteEntity(String, Coordinate2D, Size, int, int) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Create a new DynamicSpriteEntity for the given image resource on the given Coordinate2D, with the given Size.
DynamicTextEntity - Class in com.github.hanyaeger.api.entities.impl
An DynamicTextEntity extends all behaviour of a TextEntity, but also implements the Updatable Interface.
DynamicTextEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
Instantiate a new DynamicTextEntity for the given initialLocation.
DynamicTextEntity(Coordinate2D, String) - Constructor for class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
Instantiate a new DynamicTextEntity for the given Point2D and textDelegate.

E

Effectable - Interface in com.github.hanyaeger.core
By implementing the interface Effectable, it is possible to apply various effects on both a YaegerScene and a YaegerEntity.
EllipseEntity - Class in com.github.hanyaeger.api.entities.impl
An EllipseEntity provides the option to use a drawable Ellipse as a YaegerEntity.
EllipseEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.EllipseEntity
Create a new EllipseEntity on the given initialLocation.
EllipseEntity(Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.entities.impl.EllipseEntity
Create a new EllipseEntity on the given initialPosition with the given Size.
enableScroll() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns the value of the enableScroll record component.
EntityCollection - Class in com.github.hanyaeger.core.entities
An EntityCollection encapsulates all behaviour related to all instances of YaegerEntity that are part of a YaegerScene.
EntityCollection(YaegerConfig) - Constructor for class com.github.hanyaeger.core.entities.EntityCollection
Instantiate an EntityCollection for a given Group and a Set of YaegerEntity instances.
EntityCollectionFactory - Class in com.github.hanyaeger.core.factories
A EntityCollectionFactory should be used to create instances of EntityCollection.
EntityCollectionFactory() - Constructor for class com.github.hanyaeger.core.factories.EntityCollectionFactory
 
entityCollectionUpdatable() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
EntityConfiguration<C> - Class in com.github.hanyaeger.core.entities
A wrapper class that allows entities to be configured using a generic configuration object.
EntityConfiguration(Class<? extends YaegerEntity>) - Constructor for class com.github.hanyaeger.core.entities.EntityConfiguration
Create a new EntityConfiguration for the given Class.
EntityConfiguration(Class<? extends YaegerEntity>, C) - Constructor for class com.github.hanyaeger.core.entities.EntityConfiguration
Create a new EntityConfiguration for the given Class and configuration of type EntityConfiguration.
EntityMotionInitBuffer - Class in com.github.hanyaeger.core.entities.motion
An EntityMotionInitBuffer is used to support the option to set the speed, direction and physics related properties of an YaegerEntity from the constructor.
EntityMotionInitBuffer() - Constructor for class com.github.hanyaeger.core.entities.motion.EntityMotionInitBuffer
 
EntityProcessor - Interface in com.github.hanyaeger.core.entities
When a YaegerEntity needs to be processed, in general meaning it should be passed as a parameter to a specific method, this functional interface can be used as the basis for a Lambda expression.
EntitySpawner - Class in com.github.hanyaeger.api.entities
An EntitySpawner is the abstract superclass that should be extended to create an object that spawns a subclass of YaegerEntity.
EntitySpawner(long) - Constructor for class com.github.hanyaeger.api.entities.EntitySpawner
Create a new instance of EntitySpawner for the given interval in milliseconds.
EntitySpawnerContainer - Interface in com.github.hanyaeger.api
An EntitySpawnerContainer enables a YaegerScene to use instances of EntitySpawner.
EntitySupplier - Class in com.github.hanyaeger.core.entities
An EntitySupplier extends a ArrayList of instances of YaegerEntity.
EntitySupplier() - Constructor for class com.github.hanyaeger.core.entities.EntitySupplier
 
EntitySupplierFactory - Class in com.github.hanyaeger.core.factories
An EntitySupplierFactory is responsible for creating instances of EntitySupplier.
EntitySupplierFactory() - Constructor for class com.github.hanyaeger.core.factories.EntitySupplierFactory
 
equals(Object) - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.hanyaeger.api.entities.impl.CustomFont
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.github.hanyaeger.api.scenes.TileMap
 
equals(Object) - Method in record class com.github.hanyaeger.api.Size
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class com.github.hanyaeger.core.entities.EntitySupplier
 
equals(Object) - Method in class com.github.hanyaeger.core.SceneCollection
 
equals(Object) - Method in record class com.github.hanyaeger.core.YaegerConfig
Indicates whether some other object is "equal to" this one.
EventInitiator<T> - Interface in com.github.hanyaeger.core.entities
By implementing the interface EventInitiator it is possible to register an EventHandler for a given EventType.
EXCEPTION_X_Y_IS_0 - Static variable in class com.github.hanyaeger.api.Coordinate2D
The message as to be shown in case a IllegalArgumentException occurs as the result of some methods from this class.
explicitUpdate(long) - Method in interface com.github.hanyaeger.api.UpdateExposer
An explicit update that can be used from either a YaegerEntity or a YaegerScene.
exposedUpdate() - Method in interface com.github.hanyaeger.api.UpdateExposer

F

FadeInTimer - Class in com.github.hanyaeger.core.scenes.splash
A Timer that is to be used for creating the fade-in effect of the SplashScene.
FadeInTimer(YaegerScene) - Constructor for class com.github.hanyaeger.core.scenes.splash.FadeInTimer
Create a new instance of FadeInTimer.
FiniteAnimation - Record Class in com.github.hanyaeger.api.entities
A FiniteAnimation implements the interface Animation and should be used when the Animation should be played ony once.
FiniteAnimation(int, int, int, int) - Constructor for record class com.github.hanyaeger.api.entities.FiniteAnimation
Create a new instance of LinkedAnimation
FiniteAnimation(int, int, int, int, long) - Constructor for record class com.github.hanyaeger.api.entities.FiniteAnimation
Creates an instance of a FiniteAnimation record class.
FiniteAnimationWithCallBack - Record Class in com.github.hanyaeger.api.entities
A FiniteAnimation implements the interface Animation and should be used when the Animation should be played ony once.
FiniteAnimationWithCallBack(int, int, int, int, long, AnimationCallback) - Constructor for record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Creates an instance of a FiniteAnimationWithCallBack record class.
FiniteAnimationWithCallBack(int, int, int, int, AnimationCallback) - Constructor for record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Create a new instance of FiniteAnimationWithCallBack

G

GameNode - Interface in com.github.hanyaeger.core.entities
Being a GameNode guarantees that a Node, if set, is accessible.
get() - Method in class com.github.hanyaeger.core.entities.EntitySupplier
Return a List of instances of YaegerEntity.
get() - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
Return the current transformation.
get(String) - Method in class com.github.hanyaeger.core.repositories.AudioRepository
Return a AudioClip for the given [@code audiofile].
get(String) - Method in class com.github.hanyaeger.core.repositories.ImageRepository
Return an Image with content loaded from the specified url.
get(String, double, double, boolean) - Method in class com.github.hanyaeger.core.repositories.ImageRepository
Construct a new Image with the specified parameters.
get(String, int) - Method in class com.github.hanyaeger.core.repositories.AudioRepository
Return a AudioClip for the given [@code audiofile] and cycleCount.
getActiveScene() - Method in class com.github.hanyaeger.core.SceneCollection
Return the YaegerScene currently active.
getAnchorLocation() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getAnchorLocation() - Method in interface com.github.hanyaeger.core.entities.Placeable
Return the Coordinate2D where the AnchorPoint of this YaegerEntity is placed, within the YaegerScene.
getAnchorPoint() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getAnchorPoint() - Method in class com.github.hanyaeger.api.scenes.TileMap
 
getAnchorPoint() - Method in interface com.github.hanyaeger.core.entities.Anchorable
Return the AnchorPoint of this Placeable.
getArcHeight() - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
Return the arcHeight of this RectangleEntity.
getArcWidth() - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
Return the arcWidth of this RectangleEntity.
getAutoCycleInterval() - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Return the current auto-cycle interval
getAutoCycleRow() - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Return the row that is currently set as the only row to cycle through.
getBackgroundAudioVolume() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getBackgroundAudioVolume() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Return the playback volume of the background audio.
getBackgroundAudioVolume() - Method in class com.github.hanyaeger.api.YaegerGame
Return the playback volume of the background audio.
getBoundingBox() - Method in interface com.github.hanyaeger.core.entities.Bounded
Return the Bounds (Bounding Box) within the YaegerScene after all transformations have been applied.
getBrightness() - Method in interface com.github.hanyaeger.core.Effectable
Return the brightness level of this YaegerScene or YaegerEntity.
getBrightness() - Method in class com.github.hanyaeger.core.YaegerGameObject
 
getBuffer() - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
getBuffer() - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
getBuffer() - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
getBuffer() - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
getBuffer() - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
getBuffer() - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
getBuffer() - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
Return the EntityMotionInitBuffer encapsulated in an Optional to be used by this BufferedMovable.
getConfiguration() - Method in class com.github.hanyaeger.core.entities.EntityConfiguration
Return the configuration (of type EntityConfiguration) that should be applied to the Class.
getContrast() - Method in interface com.github.hanyaeger.core.Effectable
Return the contrast level of this YaegerScene or YaegerEntity.
getContrast() - Method in class com.github.hanyaeger.core.YaegerGameObject
 
getCurrentAnimation() - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Return the Animation that is currently being played.
getCurrentAnimation() - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Return the Animation that is currently being played.
getCurrentFrameIndex() - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Return the current index of the sprite.
getCursor() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Return the Cursor that is currently being used.
getCyclingRow() - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Return the row that is currently set as the only row to cycle through.
getDirection() - Method in interface com.github.hanyaeger.core.entities.motion.DirectionProvider
Get the direction in which the YaegerEntity is moving, in degrees.
getDirection() - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getDirection() - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
getDraggedObject() - Method in class com.github.hanyaeger.core.repositories.DragNDropRepository
Get the Object that is currently being dragged.
getDragNDropRepository() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getDragNDropRepository() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getDragNDropRepository() - Method in interface com.github.hanyaeger.core.entities.DragRepositoryAccessor
Return the DragNDropRepository that was set on this DragRepositoryAccessor.
getEntityClass() - Method in class com.github.hanyaeger.core.entities.EntityConfiguration
Return the Class of the YaegerEntity.
getEntityCollection() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getEntitySupplier() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getFill() - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Return the fill used for this ShapeEntity.
getFont() - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
Return the Font currently used fot this TextEntity.
getFrameIndex() - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Return the current index of the sprite.
getFrames() - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Return the number of frames comprising this SpriteEntity.
getFrictionConstant() - Method in interface com.github.hanyaeger.api.entities.Newtonian
 
getFrictionConstant() - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getFrictionConstant() - Method in interface com.github.hanyaeger.core.entities.motion.NewtonianModifier
Return the friction constant used.
getGravityConstant() - Method in interface com.github.hanyaeger.api.entities.Newtonian
 
getGravityConstant() - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getGravityConstant() - Method in interface com.github.hanyaeger.core.entities.motion.NewtonianModifier
Return the gravitational constant used.
getGravityDirection() - Method in interface com.github.hanyaeger.api.entities.Newtonian
 
getGravityDirection() - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getGravityDirection() - Method in interface com.github.hanyaeger.core.entities.motion.NewtonianModifier
Return the gravitational direction used.
getHeight() - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
 
getHeight() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Return the height of the complete scene.
getHeight() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Return the height of this YaegerScene.
getHeight() - Method in interface com.github.hanyaeger.core.entities.Bounded
 
getHorizontalRelativeScrollPosition() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Return the current horizontal scroll position of the viewport.
getHue() - Method in interface com.github.hanyaeger.core.Effectable
Return the contrast level of this YaegerScene or YaegerEntity.
getHue() - Method in class com.github.hanyaeger.core.YaegerGameObject
 
getInitializationBuffer() - Method in interface com.github.hanyaeger.api.entities.Rotatable
Return an instance of InitializationBuffer to be used whenever a Node is unavailable to apply the rotation.
getInitializationBuffer() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getInjector() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getInjector() - Method in interface com.github.hanyaeger.core.DependencyInjector
Return an Injector that can be used to inject dependencies into this Object.
getInstance() - Static method in class com.github.hanyaeger.core.repositories.AudioRepository
Return a singleton instance of this AudioRepository.
getInstanceMap() - Method in class com.github.hanyaeger.api.scenes.TileMap
Return a two-dimensional array of instances of YaegerEntity that contains the instances created by this TileMap.
getIntervalInMs() - Method in class com.github.hanyaeger.api.Timer
Return the interval in ms that is being used by this Timer.
getLocationInScene() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Calculate the absolute location of this YaegerEntity in the scene.
getMotionApplier() - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
getMotionApplier() - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
getMotionApplier() - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
getMotionApplier() - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
getMotionApplier() - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
getMotionApplier() - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
getMotionApplier() - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
Return the MotionApplier to be used by this BufferedMovable.
getMotionApplier() - Method in interface com.github.hanyaeger.core.entities.motion.Movable
Return the MotionApplier that should be used.
getNamedAnimations() - Method in interface com.github.hanyaeger.core.entities.NamedAnimationListProvider
Return the List of FiniteAnimation instances.
getNode() - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
getNode() - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
 
getNode() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getNode() - Method in interface com.github.hanyaeger.core.entities.GameNode
Return an Optional of the Node that is related to this GameNode.
getNode() - Method in class com.github.hanyaeger.core.entities.ShapeEntity
 
getOpacity() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Return the opacity of this YaegerEntity, meaning how opaque (that is, solid) the YaegerEntity appears.
getPane() - Method in class com.github.hanyaeger.core.entities.EntitySupplier
Get the Pane on which each Node that is part of the YaegerEntity, should be added.
getRadius() - Method in class com.github.hanyaeger.api.entities.impl.CircleEntity
Return the radius of this CircleEntity.
getRadiusX() - Method in class com.github.hanyaeger.api.entities.impl.EllipseEntity
Return the horizontal radius of this EllipseEntity.
getRadiusY() - Method in class com.github.hanyaeger.api.entities.impl.EllipseEntity
Return the vertical radius of this CircleEntity.
getRemoveHandlers() - Method in class com.github.hanyaeger.core.entities.motion.InitializationBuffer
Return all the EventHandler that should be registered for EventTypes.REMOVE.
getRootPane() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Return the root pane to which this YaegerEntity is added.
getRootPane() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getRootPane() - Method in interface com.github.hanyaeger.core.RootPaneProvider
Return the root pane.
getRotation() - Method in interface com.github.hanyaeger.api.entities.Rotatable
Return the rotation of the YaegerEntity.
getRotation() - Method in class com.github.hanyaeger.core.entities.motion.InitializationBuffer
Return the value of rotation.
getRotationSpeed() - Method in interface com.github.hanyaeger.api.entities.ContinuousRotatable
Return the angle that should be added each update to the rotation of the YaegerEntity.
getRotationSpeed() - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
getRotationSpeed() - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
getRotationSpeed() - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
getRotationSpeed() - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
getRotationSpeed() - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
getRotationSpeed() - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
getSaturation() - Method in interface com.github.hanyaeger.core.Effectable
Return the saturation level of this YaegerScene or YaegerEntity.
getSaturation() - Method in class com.github.hanyaeger.core.YaegerGameObject
 
getScene() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
 
getScene() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getScene() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Return the Scene that is encapsulated by this YaegerScene
getSceneHeight() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getSceneHeight() - Method in interface com.github.hanyaeger.core.entities.SceneChild
Return the height of the YaegerScene that this Entity is part of.
getSceneWidth() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getSceneWidth() - Method in interface com.github.hanyaeger.core.entities.SceneChild
Return the width of the YaegerScene that this Entity is part of.
getSpawners() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
 
getSpeed() - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getSpeed() - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
getSpeed() - Method in interface com.github.hanyaeger.core.entities.motion.SpeedProvider
Return the current speed as a double.
getSpeedInDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getSpeedInDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Since a motion can be described as a vector, such a vector can be decomposed in two perpendicular components, of which one is parallel to the given direction.
getSpeedInDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
getSpeedInDirection(Direction) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
getSpeedInDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
 
getSpeedInDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
getStage() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getStage() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Return the Stage to which this YaegerScene will be added.
getStatistics() - Method in class com.github.hanyaeger.core.entities.EntityCollection
Return the statistics related to this EntityCollection.
getStrokeColor() - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Return the strokeColor used for this ShapeEntity.
getStrokeWidth() - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Return the strokeWidth used for this ShapeEntity.
getSupplier() - Method in class com.github.hanyaeger.api.entities.EntitySpawner
Return the EntitySupplier that is part of this EntitySpawner.
getText() - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
Return the text that is being displayed.
getTileMaps() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
getTimers() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
getTimers() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
 
getTimers() - Method in interface com.github.hanyaeger.core.TimerListProvider
Return the List of Timer instances.
getUpdater() - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
getUpdater() - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
getUpdater() - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
getUpdater() - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
getUpdater() - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
getUpdater() - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
getUpdater() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
 
getUpdater() - Method in interface com.github.hanyaeger.core.UpdateDelegator
Get the Updater to which the update should be delegated.
getValue() - Method in enum class com.github.hanyaeger.api.entities.Direction
Return the numeric value of this enumeration.
getVerticalRelativeScrollPosition() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Return the current vertical scroll position of the viewport.
getViewOrder() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Return the viewOrder of this YaegerEntity.
getViewportHeight() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Return the height of the viewport.
getViewportWidth() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Return the width of the viewport.
getVolume() - Method in class com.github.hanyaeger.api.media.SoundClip
Get the default volume level.
getVolume() - Method in class com.github.hanyaeger.core.media.BackgroundAudioMediaPlayer
Retrieves the audio playback volume.
getVolume() - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Retrieves the background audio playback volume.
getWidth() - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
 
getWidth() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Return the width of the complete scene.
getWidth() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Return the width of this YaegerScene.
getWidth() - Method in interface com.github.hanyaeger.core.entities.Bounded
 

H

handle() - Method in class com.github.hanyaeger.core.factories.animationtimer.TimeableAnimationTimer
Method called whenever the interval time is reached
handle() - Method in interface com.github.hanyaeger.core.factories.animationtimer.TimeableAnimationTimerHandler
Called when a AnimationTimer calls its internal AnimationTimer.handle(long) ()}
handle(long) - Method in class com.github.hanyaeger.api.entities.EntitySpawner
 
handle(long) - Method in class com.github.hanyaeger.api.Timer
Handle an update.
handle(long) - Method in interface com.github.hanyaeger.core.factories.animationtimer.AnimationTimerHandler
Called when a AnimationTimer calls its internal handle()
handle(long) - Method in class com.github.hanyaeger.core.factories.animationtimer.TimeableAnimationTimer
 
handle(long) - Method in class com.github.hanyaeger.core.YaegerAnimationTimer
 
handleOn60fps(long) - Method in class com.github.hanyaeger.core.YaegerAnimationTimer
This method needs to be overridden by extending classes.
hanyaeger - module hanyaeger
The main (and only) module for Yaeger.
hashCode() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns a hash code value for this object.
hashCode() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns a hash code value for this object.
hashCode() - Method in record class com.github.hanyaeger.api.entities.impl.CustomFont
Returns a hash code value for this object.
hashCode() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns a hash code value for this object.
hashCode() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns a hash code value for this object.
hashCode() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns a hash code value for this object.
hashCode() - Method in class com.github.hanyaeger.api.scenes.TileMap
 
hashCode() - Method in record class com.github.hanyaeger.api.Size
Returns a hash code value for this object.
hashCode() - Method in class com.github.hanyaeger.core.entities.EntitySupplier
 
hashCode() - Method in class com.github.hanyaeger.core.SceneCollection
 
hashCode() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns a hash code value for this object.
height() - Method in record class com.github.hanyaeger.api.Size
Returns the value of the height record component.

I

ImageFactory - Class in com.github.hanyaeger.core.factories.image
An ImageFactory should be used for creating instance of Image.
ImageFactory() - Constructor for class com.github.hanyaeger.core.factories.image.ImageFactory
 
ImageRepository - Class in com.github.hanyaeger.core.repositories
An ImageRepository provides a central repository for acquiring sprites.
ImageRepository() - Constructor for class com.github.hanyaeger.core.repositories.ImageRepository
 
ImageViewFactory - Class in com.github.hanyaeger.core.factories.image
An ImageViewFactory should be used for creating instance of ImageView.
ImageViewFactory() - Constructor for class com.github.hanyaeger.core.factories.image.ImageViewFactory
 
incrementSpeed(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
incrementSpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Alter the speed through addition.
incrementSpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
INDEFINITE - Static variable in class com.github.hanyaeger.api.media.SoundClip
When instantiating a SoundClip, the value of the constructor parameter cycleCount can be used to set the number of times the audio file should be played.
init(Injector) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.CircleEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.EllipseEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
init(Injector) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
init(Injector) - Method in class com.github.hanyaeger.core.entities.EntityCollection
 
init(Injector) - Method in class com.github.hanyaeger.core.entities.motion.EntityMotionInitBuffer
 
init(Injector) - Method in class com.github.hanyaeger.core.entities.ShapeEntity
 
init(Injector) - Method in interface com.github.hanyaeger.core.Initializable
 
init(Injector) - Method in class com.github.hanyaeger.core.SceneCollection
 
init(Injector) - Method in class com.github.hanyaeger.core.YaegerStage
 
Initializable - Interface in com.github.hanyaeger.core
Stating an Object is Initializable exposes the Initializable.init(Injector) lifecycle hook.
InitializationBuffer - Class in com.github.hanyaeger.core.entities.motion
A InitializationBuffer is a simple data container, only used for storing the values can be set before an YaegerEntity gets initialized and the Node is available.
InitializationBuffer() - Constructor for class com.github.hanyaeger.core.entities.motion.InitializationBuffer
 
initialUpdate() - Method in class com.github.hanyaeger.core.entities.EntityCollection
Perform the initial update, to ensure all available entities are transferred from their EntitySupplier to the actual collections to become part of the EntityCollection.
initSpawners() - Method in interface com.github.hanyaeger.api.EntitySpawnerContainer
Initialize all instances of EntitySpawner that were added to this EntitySpawnerContainer.
initTileMaps() - Method in interface com.github.hanyaeger.api.scenes.TileMapContainer
Initialize all instances of TileMap that were added to this TileMapContainer.
initTimers() - Method in interface com.github.hanyaeger.api.TimerContainer
Annotated with OnActivation, this method will be called during activation.
invert() - Method in class com.github.hanyaeger.api.Coordinate2D
Return a Coordinate2D which is the inverse of this coordinate
invertSpeedInDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
invertSpeedInDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Since a motion can be described as a vector, such a vector can be decomposed in two perpendicular components, of which one is parallel to the given direction.
invertSpeedInDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
invertSpeedInDirection(Direction) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
invertSpeedInDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
 
invertSpeedInDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
invokeActivators(Object) - Method in class com.github.hanyaeger.core.annotations.AnnotationProcessor
Invoke all methods annotated with the annotation OnActivation on the given Object.
invokePostActivators(Object) - Method in class com.github.hanyaeger.core.annotations.AnnotationProcessor
Invoke all methods annotated with the annotation OnPostActivation on the given Object.
isActivationComplete() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
isActivationComplete() - Method in interface com.github.hanyaeger.core.Activatable
Return whether this YaegerScene has completed activation.
isActive() - Method in class com.github.hanyaeger.api.Timer
State whether this Timer is currently active.
isActiveGWU() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
Returns whether the Game World Update is active or not.
isGarbage() - Method in class com.github.hanyaeger.api.Timer
State whether this Timer has been marked as garbage.
isVisible() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Return the visibility of this YaegerEntity.

K

KeyListener - Interface in com.github.hanyaeger.api.userinput
A KeyListener is notified when the set of pressed keys changes.
KeyListenerDelegate - Class in com.github.hanyaeger.core.scenes.delegates
A KeyListenerDelegate follows the Delegate pattern and embraces Composition over Inheritance.
KeyListenerDelegate() - Constructor for class com.github.hanyaeger.core.scenes.delegates.KeyListenerDelegate
 

L

LEFT - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The direction to the left, of which the numeric value is 270 degrees.
LEFT - Enum constant in enum class com.github.hanyaeger.api.scenes.SceneBorder
The top of the YaegerScene.
limitGWU() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns the value of the limitGWU record component.
LINE_INTERVAL - Static variable in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
 
LineFactory - Class in com.github.hanyaeger.core.factories
An LineFactory should be used for creating instance of Line.
LineFactory() - Constructor for class com.github.hanyaeger.core.factories.LineFactory
 
LinkedAnimation - Record Class in com.github.hanyaeger.api.entities
A LinkedAnimation implements the interface Animation with the ability to set the next Animation to be played, after this one has finished.
LinkedAnimation(int, int, int, int, long, Animation) - Constructor for record class com.github.hanyaeger.api.entities.LinkedAnimation
Creates an instance of a LinkedAnimation record class.
LinkedAnimation(int, int, int, int, Animation) - Constructor for record class com.github.hanyaeger.api.entities.LinkedAnimation
Create a new instance of LinkedAnimation
LinkedAnimationWithCallBack - Record Class in com.github.hanyaeger.api.entities
A LinkedAnimationWithCallBack implements the interface Animation with the ability to set the next Animation to be played, after this one has finished.
LinkedAnimationWithCallBack(int, int, int, int, long, Animation, AnimationCallback) - Constructor for record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Creates an instance of a LinkedAnimationWithCallBack record class.
LinkedAnimationWithCallBack(int, int, int, int, Animation, AnimationCallback) - Constructor for record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Create a new instance of LinkedAnimationWithCallBack
LocationUpdater - Interface in com.github.hanyaeger.core.entities.motion
A LocationUpdater can calculate a new location.
loop() - Method in interface com.github.hanyaeger.api.entities.Animation
A value that states whether this Animation should loop after it has finished.
loop() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
 
LoopingAnimation - Record Class in com.github.hanyaeger.api.entities
A LoopingAnimation implements the interface Animation and should be used when the Animation should loop.
LoopingAnimation(int, int, int, int) - Constructor for record class com.github.hanyaeger.api.entities.LoopingAnimation
Create a new instance of LinkedAnimation
LoopingAnimation(int, int, int, int, long) - Constructor for record class com.github.hanyaeger.api.entities.LoopingAnimation
Creates an instance of a LoopingAnimation record class.

M

maximizeMotionInDirection(double, double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
maximizeMotionInDirection(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Since the motion can be described as a vector, such a vector can be decomposed in two perpendicular components.
maximizeMotionInDirection(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
maximizeMotionInDirection(Direction, double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
maximizeMotionInDirection(Direction, double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
 
maximizeMotionInDirection(Direction, double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
MediaFactory - Class in com.github.hanyaeger.core.factories
An MediaFactory should be used for creating instance of Media and MediaPlayer.
MediaFactory() - Constructor for class com.github.hanyaeger.core.factories.MediaFactory
 
middlePoint(Coordinate2D) - Method in class com.github.hanyaeger.api.Coordinate2D
Returns a Coordinate2D which lies in the middle between this Coordinate2D and the specified Coordinate2D.
MotionApplier - Class in com.github.hanyaeger.core.entities.motion
A MotionApplier provides basis behaviour regarding speed and direction of a YaegerEntity
MotionApplier() - Constructor for class com.github.hanyaeger.core.entities.motion.MotionApplier
Create a new instance of MotionApplier.
MotionModifier - Interface in com.github.hanyaeger.core.entities.motion
A MotionModifier is the basic interface that defines the API of all Objects that capable of modifying the motion of a YaegerEntity.
MouseButtonPressedListener - Interface in com.github.hanyaeger.api.userinput
A MouseButtonPressedListener enables the YaegerEntity or YaegerScene to be notified if a MouseButton has been clicked while the mouse pointer is on the YaegerEntity or YaegerScene.
MouseButtonReleasedListener - Interface in com.github.hanyaeger.api.userinput
A MouseButtonReleasedListener enables the YaegerEntity or YaegerScene to be notified if a MouseButton has been released while the mouse pointer is on the YaegerEntity or YaegerScene.
MouseDragEnterListener - Interface in com.github.hanyaeger.api.userinput
A MouseDragEnterListener enables the YaegerEntity or YaegerScene to be notified when the area defined by its BoundingBox is being entered by something that is being dragged.
MouseDragExitedListener - Interface in com.github.hanyaeger.api.userinput
A MouseDragExitedListener enables the YaegerEntity or YaegerScene to be notified when the area defined by its BoundingBox is being exited by something that is being dragged.
MouseDraggedListener - Interface in com.github.hanyaeger.api.userinput
Being a MouseDraggedListener enables the YaegerEntity or YaegerScene to be notified when a mouse button is pressed on this the area defined by the BoundingBox of an YaegerEntity or YaegerScene, and then dragged.
MouseDropListener - Interface in com.github.hanyaeger.api.userinput
A MouseDropListener enables the YaegerEntity or YaegerScene to be notified when within the area defined by its BoundingBox something that is being dragged is dropped.
MouseEnterListener - Interface in com.github.hanyaeger.api.userinput
A MouseEnterListener enables the YaegerEntity or YaegerScene to be notified if the Mouse Cursor has entered the area defined by the BoundingBox of the YaegerEntity or YaegerScene.
MouseExitListener - Interface in com.github.hanyaeger.api.userinput
A MouseExitListener enables the YaegerEntity or YaegerScene to be notified if the Mouse Cursor has exited the area defined by the BoundingBox of the YaegerEntity or YaegerScene.
MouseMovedListener - Interface in com.github.hanyaeger.api.userinput
A MouseMovedListener enables the YaegerEntity or YaegerScene to be notified if the mouse has been moved.
MouseMovedWhileDraggingListener - Interface in com.github.hanyaeger.api.userinput
Being a MouseMovedWhileDraggingListener enables the YaegerEntity or YaegerScene to be notified if the mouse has been moved while it is dragging a MouseDraggedListener or nothing at all.
Movable - Interface in com.github.hanyaeger.core.entities.motion
When the Interface Movable is implemented, an YaegerEntity is able to move around the YaegerScene on each Game World Update.
multiply(Coordinate2D) - Method in class com.github.hanyaeger.api.Coordinate2D
Return a Coordinate2D with the coordinates of the specified point multiplied by the coordinates of this Coordinate2D.
multiplySpeed(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
multiplySpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Alter the speed through multiplication.
multiplySpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 

N

NamedAnimationListProvider - Interface in com.github.hanyaeger.core.entities
Implementing the NamedAnimationListProvider interface guarantees that a List of instances of FiniteAnimation is available.
Newtonian - Interface in com.github.hanyaeger.api.entities
A Newtonian is a special case of a Movable that abides the basic laws of gravity and friction.
NewtonianModifier - Interface in com.github.hanyaeger.core.entities.motion
A NewtonianModifier is capable of modifying all properties that are related to the laws of gravity and friction.
next() - Method in interface com.github.hanyaeger.api.entities.Animation
A value that returns the next Animation to be played, after this instance has finished.
next() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns the value of the next record component.
next() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the next record component.
normalize() - Method in class com.github.hanyaeger.api.Coordinate2D
Return a normalized Coordinate2D.
notifyBoundaryCrossing(SceneBorder) - Method in interface com.github.hanyaeger.api.entities.SceneBorderCrossingWatcher
This method is being called when this SceneBorderCrossingWatcher crosses a border of the YaegerScene.
notifyBoundaryTouching(SceneBorder) - Method in interface com.github.hanyaeger.api.entities.SceneBorderTouchingWatcher
This method is being called when this SceneBorderTouchingWatcher touches a border of the YaegerScene.
notifyGameObjectsOfPressedKeys(Set<KeyCode>) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Notify all YaegerEntity that implement the interface KeyListener that keys are being pressed.
notifyRemove() - Method in interface com.github.hanyaeger.core.entities.Removable
Send a Event to notify all Listeners that this Removable should be removed.
nullifySpeedInDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
nullifySpeedInDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Since the motion can be described as a vector, such a vector can be decomposed in two perpendicular components, of which one is parallel to the given direction.
nullifySpeedInDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
nullifySpeedInDirection(Direction) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
nullifySpeedInDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
 
nullifySpeedInDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
NULLPOINTER_LOCATION - Static variable in class com.github.hanyaeger.api.Coordinate2D
The message as to be shown in case a NullPointerException occurs as the result of some methods from this class.

O

OnActivation - Annotation Interface in com.github.hanyaeger.core.annotations
A method annotated with OnActivation will be automatically called by the AnnotationProcessor during activation of either an YaegerEntity or a YaegerScene.
onAnimationUpdate(long) - Method in class com.github.hanyaeger.api.entities.EntitySpawner
 
onAnimationUpdate(long) - Method in class com.github.hanyaeger.api.Timer
Implement this method, which will be called each animation update with the given interval.
onAnimationUpdate(long) - Method in class com.github.hanyaeger.core.scenes.splash.FadeInTimer
 
onCollision(List<Collider>) - Method in interface com.github.hanyaeger.api.entities.Collided
This method is called if a collision has occurred.
onDragEntered(Coordinate2D, MouseDraggedListener) - Method in interface com.github.hanyaeger.api.userinput.MouseDragEnterListener
Called when the area defined by the BoundingBox of this YaegerEntity or YaegerScene is being entered by something that is being dragged.
onDragExited(Coordinate2D, MouseDraggedListener) - Method in interface com.github.hanyaeger.api.userinput.MouseDragExitedListener
Called when the area defined by the BoundingBox of this YaegerEntity or YaegerScene is being exited by something that is being dragged.
onDragged(Coordinate2D) - Method in interface com.github.hanyaeger.api.userinput.MouseDraggedListener
Called when the YaegerEntity is being dragged.
onDrop(Coordinate2D, MouseDraggedListener) - Method in interface com.github.hanyaeger.api.userinput.MouseDropListener
Called when within the area defined by the BoundingBox of this YaegerEntity or YaegerScene something that is being dragged is dropped.
onDropped(Coordinate2D) - Method in interface com.github.hanyaeger.api.userinput.MouseDraggedListener
Called when the YaegerEntity is being dropped.
onMouseButtonPressed(MouseButton, Coordinate2D) - Method in interface com.github.hanyaeger.api.userinput.MouseButtonPressedListener
Called when the corresponding Node receives a mouse pressed event.
onMouseButtonReleased(MouseButton, Coordinate2D) - Method in interface com.github.hanyaeger.api.userinput.MouseButtonReleasedListener
Called when the corresponding Node receives a mouse released event.
onMouseEntered() - Method in interface com.github.hanyaeger.api.userinput.MouseEnterListener
Called when the corresponding Node receives a mouse enter event.
onMouseExited() - Method in interface com.github.hanyaeger.api.userinput.MouseExitListener
Called when the corresponding Node receives a mouse exited event.
onMouseMoved(Coordinate2D) - Method in interface com.github.hanyaeger.api.userinput.MouseMovedListener
Called when the corresponding Node receives a mouse moved event.
onMouseMovedWhileDragging(Coordinate2D) - Method in interface com.github.hanyaeger.api.userinput.MouseMovedWhileDraggingListener
Called when the corresponding Node receives a mouse pressed event.
OnPostActivation - Annotation Interface in com.github.hanyaeger.core.annotations
A method annotated with OnActivation will be automatically called by the AnnotationProcessor after activation of either an YaegerEntity or a YaegerScene.
onPressedKeysChange(Set<KeyCode>) - Method in interface com.github.hanyaeger.api.userinput.KeyListener
Called when the set of pressed keys changes.

P

PaneFactory - Class in com.github.hanyaeger.core.factories
A PaneFactory can be used to create instances of Pane or ScrollPane.
PaneFactory() - Constructor for class com.github.hanyaeger.core.factories.PaneFactory
 
parseToConfig(List<String>) - Method in class com.github.hanyaeger.core.YaegerCommandLineParser
Parse the given command line Arguments and create a YaegerConfig that can be used to initialize a YaegerGame.
path() - Method in record class com.github.hanyaeger.api.entities.impl.CustomFont
Returns the value of the path record component.
pause() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
Pause the Game World Update (GWU) of this YaegerScene.
pause() - Method in class com.github.hanyaeger.api.Timer
Pause the timer, so it will no longer update with each animation.
Placeable - Interface in com.github.hanyaeger.core.entities
A Placeable has a methods that can be used to place it at a different x,y-coordinates on the YaegerScene.
play() - Method in class com.github.hanyaeger.api.media.SoundClip
Play the file.
playAnimation(Animation) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Play the given Animation.
playAnimation(Animation, boolean) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Play the given Animation.
playAnimation(Animation, boolean) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Play the given FiniteAnimation.
playBackgroundAudio(String) - Method in class com.github.hanyaeger.core.media.BackgroundAudioMediaPlayer
Set the background audio.
postActivate() - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
 
postActivate() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
postActivate() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Use this method to trigger behaviour that should be set after the YaegerScene has been completely set up.
postActivation() - Method in class com.github.hanyaeger.core.entities.Debugger
Ensure that the Debugger is brought to the top of the view stack.
postActivation() - Method in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
Use this method to trigger behaviour that should be set after the CoordinateGridDelegate has been completely set up.
process(YaegerEntity) - Method in interface com.github.hanyaeger.core.entities.EntityProcessor
Process the given YaegerEntity.

Q

queueAnimation(Animation) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Queue the given Animation ensures it is played after the current Animation, regardless of the type of the current Animation.
quit() - Method in class com.github.hanyaeger.api.YaegerGame
Stop and close the Game.
quit() - Method in class com.github.hanyaeger.core.YaegerStage
Stop and close the Game.

R

RectangleEntity - Class in com.github.hanyaeger.api.entities.impl
A RectangleEntity provides the option to use a drawable Rectangle as an YaegerEntity.
RectangleEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.RectangleEntity
Create a new RectangleEntity on the given initialLocation.
RectangleEntity(Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.entities.impl.RectangleEntity
Create a new RectangleEntity on the given initialPosition with the given Size.
register(Collided) - Method in class com.github.hanyaeger.core.entities.CollisionDelegate
Register a Collided to be evaluated for collision detection.
register(Collider) - Method in class com.github.hanyaeger.core.entities.CollisionDelegate
Register a Collider to be evaluated for collision detection.
register(YaegerEntity) - Method in class com.github.hanyaeger.core.entities.CollisionDelegate
Register an YaegerEntity to be evaluated for collision detection.
registerEntitySpawners() - Method in interface com.github.hanyaeger.api.EntitySpawnerContainer
Register all instances of EntitySpawner that were added to this EntitySpawnerContainer.
registerKeyListener(KeyListener) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Register a KeyListener.
registerSupplier(EntitySupplier) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Register an EntitySupplier.
Removable - Interface in com.github.hanyaeger.core.entities
A Removable denotes an Object, most likely an YaegerEntity, that is eligible for removing from its parent.
remove() - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
remove() - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
 
remove() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
remove() - Method in class com.github.hanyaeger.api.Timer
When this method is called, this Timer is set for removal.
remove() - Method in interface com.github.hanyaeger.core.entities.Removable
Perform all necessary actions to remove the entity.
remove(Removable) - Method in class com.github.hanyaeger.core.entities.CollisionDelegate
Remove the Removable from the list of Objects that are taken into account
removeSupplier(EntitySupplier) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Remove the given EntitySupplier from the list of suppliers.
reset() - Method in class com.github.hanyaeger.api.Timer
Reset this Timer to start from the beginning again.
ResourceConsumer - Interface in com.github.hanyaeger.core
Implementing a ResourceConsumer exposes a default methode that can be used to acquire the absolute path to a resource available on the class path.
resume() - Method in class com.github.hanyaeger.api.scenes.DynamicScene
Resume a Game that has been paused (the DynamicScene.pause()) method has been called.
resume() - Method in class com.github.hanyaeger.api.Timer
Resume the timer, so it will start updating on each animation again.
RIGHT - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The direction to the right, of which the numeric value is 90 degrees.
RIGHT - Enum constant in enum class com.github.hanyaeger.api.scenes.SceneBorder
The top of the YaegerScene.
RootPaneProvider - Interface in com.github.hanyaeger.core
A RootPaneProvider is capable of providing the Pane that should be used as the root pane for all other children of Node that are part of the YaegerScene.
Rotatable - Interface in com.github.hanyaeger.api.entities
Implementing this interface will result in de availability of the Rotatable.setRotate(double) method.
rowEnd() - Method in interface com.github.hanyaeger.api.entities.Animation
The row-index of the last sprite to be shown.
rowEnd() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns the value of the rowEnd record component.
rowEnd() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns the value of the rowEnd record component.
rowEnd() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns the value of the rowEnd record component.
rowEnd() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the rowEnd record component.
rowEnd() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns the value of the rowEnd record component.
rowStart() - Method in interface com.github.hanyaeger.api.entities.Animation
The row-index of the first sprite to be shown.
rowStart() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns the value of the rowStart record component.
rowStart() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns the value of the rowStart record component.
rowStart() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns the value of the rowStart record component.
rowStart() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns the value of the rowStart record component.
rowStart() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns the value of the rowStart record component.

S

SceneBorder - Enum Class in com.github.hanyaeger.api.scenes
Since a YaegerScene is always rectangular shaped, it has fout borders, being the SceneBorder.TOP, SceneBorder.RIGHT, SceneBorder.BOTTOM and SceneBorder.LEFT.
SceneBorderCrossingWatcher - Interface in com.github.hanyaeger.api.entities
Implement this interface to be notified if the YaegerEntity crosses the boundary of the YaegerScene.
SceneBorderTouchingWatcher - Interface in com.github.hanyaeger.api.entities
Implement this interface to be notified if the YaegerEntity touches the boundary of the YaegerScene.
SceneChild - Interface in com.github.hanyaeger.core.entities
A SceneChild is part of a YaegerScene and has thus acces to width and height of the YaegerScene it is part of.
SceneCollection - Class in com.github.hanyaeger.core
A SceneCollection contains all instances of YaegerScene that are part of a Game.
SceneCollection(Stage, YaegerConfig) - Constructor for class com.github.hanyaeger.core.SceneCollection
Create a new SceneCollection for the given Stage and YaegerConfig.
SceneCollectionFactory - Class in com.github.hanyaeger.core.factories
A SceneCollectionFactory can be used to create instances of SceneCollection.
SceneCollectionFactory() - Constructor for class com.github.hanyaeger.core.factories.SceneCollectionFactory
 
SceneFactory - Class in com.github.hanyaeger.core.factories
A SceneFactory can be used to create instances of Scene.
SceneFactory() - Constructor for class com.github.hanyaeger.core.factories.SceneFactory
 
ScrollableDynamicScene - Class in com.github.hanyaeger.api.scenes
A ScrollableDynamicScene has exactly the same behaviour as a DynamicScene, but adds the option to differ between the viewable area and the actual window size.
ScrollableDynamicScene() - Constructor for class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
 
setActive(int) - Method in class com.github.hanyaeger.core.SceneCollection
Set the YaegerScene of the given int.
setActiveScene(int) - Method in class com.github.hanyaeger.api.YaegerGame
Set the current active YaegerScene.
setActiveScene(int) - Method in class com.github.hanyaeger.core.YaegerStage
Set the current active YaegerScene.
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.impl.CircleEntity
 
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.impl.EllipseEntity
 
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
 
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
 
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
 
setAnchorLocation(Coordinate2D) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
setAnchorLocation(Coordinate2D) - Method in interface com.github.hanyaeger.core.entities.Placeable
Set the Coordinate2D where the AnchorPoint of this YaegerEntity will be placed, within the YaegerScene.
setAnchorLocationX(double) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
setAnchorLocationX(double) - Method in interface com.github.hanyaeger.core.entities.Placeable
Set the x-coordinate of the AnchorLocation of this YaegerEntity;
setAnchorLocationY(double) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
setAnchorLocationY(double) - Method in interface com.github.hanyaeger.core.entities.Placeable
Set the y-coordinate of the AnchorLocation of this YaegerEntity;
setAnchorPoint(AnchorPoint) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
setAnchorPoint(AnchorPoint) - Method in class com.github.hanyaeger.api.scenes.TileMap
 
setAnchorPoint(AnchorPoint) - Method in interface com.github.hanyaeger.core.entities.Anchorable
Set the AnchorPoint of this Placeable.
setAnimationTimerFactory(AnimationTimerFactory) - Method in class com.github.hanyaeger.api.scenes.DynamicScene
Set the AnimationTimerFactory that should be used.
setAnimationTimerFactory(AnimationTimerFactory) - Method in class com.github.hanyaeger.core.scenes.delegates.KeyListenerDelegate
The AnimationTimer will be used to generate events during the time that a key is pressed for the first time, and the key-press-delay is active.
setAnnotationProcessor(AnnotationProcessor) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Set the AnnotationProcessor to be used
setAnnotationProcessor(AnnotationProcessor) - Method in class com.github.hanyaeger.core.SceneCollection
Set the AnnotationProcessor to be used.
setArcHeight(double) - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
Set the height of the arc corner of the rectangle.
setArcWidth(double) - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
Set the width of the arc corner of the rectangle.
setAutoCycle(long) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Set the interval at which the sprite should be automatically cycled.
setAutoCycle(long, int) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Set the interval at which the sprite should be automatically cycled.
setAutoCycle(long, int) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Set the interval at which the sprite should be automatically cycled and which row to cycle through.
setAutoCycleInterval(long) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
set the interval at which the sprite should be automatically cycled.
setAutoCycleRow(int) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Set the row through which the sprite should be automatically cycled.
setAutoCycleRow(int) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Set the row through which the sprite should be automatically cycled.
setBackgroundAudio(String) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setBackgroundAudio(String) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the background audio file.
setBackgroundAudio(String) - Method in class com.github.hanyaeger.api.YaegerGame
Set the background audio file.
setBackgroundAudio(String) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set the background audio.
setBackgroundAudioMediaPlayer(BackgroundAudioMediaPlayer) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
TSet the BackgroundAudioMediaPlayer to be used for this BackgroundDelegate.
setBackgroundAudioVolume(double) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setBackgroundAudioVolume(double) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the playback volume of the background audio.
setBackgroundAudioVolume(double) - Method in class com.github.hanyaeger.api.YaegerGame
Set the playback volume of the background audio.
setBackgroundColor(Color) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setBackgroundColor(Color) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the background color of the YaegerScene.
setBackgroundColor(Color) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set the background color of the YaegerScene.
setBackgroundDelegate(BackgroundDelegate) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the BackgroundDelegate that should be used.
setBackgroundFactory(BackgroundFactory) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set the BackgroundFactory to be used for this BackgroundDelegate.
setBackgroundImage(String) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setBackgroundImage(String) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the background image file.
setBackgroundImage(String, boolean) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setBackgroundImage(String, boolean) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the background image file.
setBackgroundImage(String, boolean) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set the background image.
setBrightness(double) - Method in interface com.github.hanyaeger.core.Effectable
Set the brightness of the YaegerScene or YaegerEntity.
setBrightness(double) - Method in class com.github.hanyaeger.core.YaegerGameObject
 
setColorAdjust(ColorAdjust) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the ColorAdjust that should be used.
setConfig(YaegerConfig) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setConfig(YaegerConfig) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the YaegerConfig to be used by this YaegerScene.
setContrast(double) - Method in interface com.github.hanyaeger.core.Effectable
Set the contrast of the YaegerScene or YaegerEntity.
setContrast(double) - Method in class com.github.hanyaeger.core.YaegerGameObject
 
setCoordinateGridDelegate(CoordinateGridDelegate) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setCurrentFrameIndex(int) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Set the current frame index of the Sprite image.
setCursor(Cursor) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Set the cursor to be shown.
setCursor(Cursor) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the Cursor.
setDebugger(Debugger) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the Debugger that should be used.
setDebugGridPaneFactory(DebugGridPaneFactory) - Method in class com.github.hanyaeger.core.entities.Debugger
setDebugLabelFactory(DebugLabelFactory) - Method in class com.github.hanyaeger.core.entities.Debugger
setDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
 
setDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Set the Direction.
setDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
setDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
 
setDirection(Direction) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Set the Direction, which is in essence a value in degrees, but by using this method, one can use the enumeration Direction.
setDirection(Direction) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
setDraggedObject(MouseDraggedListener) - Method in class com.github.hanyaeger.core.repositories.DragNDropRepository
Set the Object that is currently being dragged.
setDragNDropRepository(DragNDropRepository) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Set the DragNDropRepository to be used.
setDragNDropRepository(DragNDropRepository) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the DragNDropRepository that should be used.
setDragNDropRepository(DragNDropRepository) - Method in interface com.github.hanyaeger.core.entities.DragRepositoryAccessor
setEntityCollectionFactory(EntityCollectionFactory) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the EntityCollectionFactory that should be used.
setEntitySupplier(EntitySupplier) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the EntitySupplier that should be used.
setEntitySupplierFactory(EntitySupplierFactory) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Set the EntitySupplierFactory to be used
setFactory(ImageFactory) - Method in class com.github.hanyaeger.core.repositories.ImageRepository
 
setFill(Color) - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Set the fill color to be used.
setFont(CustomFont) - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
Set the CustomFont to be used.
setFont(Font) - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
Set the Font to be used.
setFrameIndex(int) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Set the index of the sprite.
setFrictionConstant(double) - Method in interface com.github.hanyaeger.api.entities.Newtonian
 
setFrictionConstant(double) - Method in class com.github.hanyaeger.core.entities.motion.EntityMotionInitBuffer
Set the friction constant to be used.
setFrictionConstant(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setFrictionConstant(double) - Method in interface com.github.hanyaeger.core.entities.motion.NewtonianModifier
Set the friction constant to be used.
setGameDimensions(Size) - Method in class com.github.hanyaeger.core.entities.Debugger
Set the dimensions of the game, which will be shown by the debugger.
setGameTitle(String) - Method in class com.github.hanyaeger.api.YaegerGame
Set the title of the Game.
setGravityConstant(double) - Method in interface com.github.hanyaeger.api.entities.Newtonian
 
setGravityConstant(double) - Method in class com.github.hanyaeger.core.entities.motion.EntityMotionInitBuffer
Set the gravity constant to be used.
setGravityConstant(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setGravityConstant(double) - Method in interface com.github.hanyaeger.core.entities.motion.NewtonianModifier
Set the gravitational constant to be used.
setGravityDirection(double) - Method in interface com.github.hanyaeger.api.entities.Newtonian
 
setGravityDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.EntityMotionInitBuffer
Set the gravity direction to be used.
setGravityDirection(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setGravityDirection(double) - Method in interface com.github.hanyaeger.core.entities.motion.NewtonianModifier
Set the gravitational direction used.
setGroup(Group) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
Set the Group that is used within this CompositeEntity.
setHeight(double) - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
Set the height of the rectangle.
setHorizontalRelativeScrollPosition(double) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the horizontal scroll position of the scene to a relative value.
setHorizontalScrollPosition(double) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the horizontal scroll position of the scene.
setHue(double) - Method in interface com.github.hanyaeger.core.Effectable
Set the hue of the YaegerScene or YaegerEntity.
setHue(double) - Method in class com.github.hanyaeger.core.YaegerGameObject
 
setImageRepository(ImageRepository) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Set the ImageRepository to be used.
setImageRepository(ImageRepository) - Method in class com.github.hanyaeger.core.entities.Debugger
setImageRepository(ImageRepository) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set the ImageRepository to be used for this BackgroundDelegate.
setImageViewFactory(ImageViewFactory) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Set the ImageViewFactory to be used.
setIntervalInMs(long) - Method in class com.github.hanyaeger.api.Timer
Set the interval in ms that should be used by this Timer.
setKeyListenerDelegate(KeyListenerDelegate) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the KeyListener that should be used.
setLineFactory(LineFactory) - Method in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
 
setMotion(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
 
setMotion(double, double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setMotion(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Set the motion with which this YaegerEntity is travelling.
setMotion(double, double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
setMotion(double, Direction) - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
 
setMotion(double, Direction) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setMotion(double, Direction) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Set the motion with which this YaegerEntity is travelling.
setMotion(double, Direction) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
setMotionApplier(MotionApplier) - Method in class com.github.hanyaeger.core.entities.motion.EntityMotionInitBuffer
Set the MotionApplier to be used when this buffer is initialized.
setMotionApplier(MotionApplier) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
Set the MotionApplier that will be used.
setOpacity(double) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Specifies how opaque (that is, solid) the YaegerEntity appears.
setPane(Pane) - Method in class com.github.hanyaeger.core.entities.EntitySupplier
Set the Pane on which each Node that is part of the YaegerEntity, should be added.
setPaneFactory(PaneFactory) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
 
setPaneFactory(PaneFactory) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the PaneFactory to be used.
setPreserveAspectRatio(boolean) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Preserve the aspect ratio of the width and height of this SpriteEntity.
setRadius(double) - Method in class com.github.hanyaeger.api.entities.impl.CircleEntity
Set the radius of the circle.
setRadiusX(double) - Method in class com.github.hanyaeger.api.entities.impl.EllipseEntity
Set the horizontal radius of the ellipse.
setRadiusY(double) - Method in class com.github.hanyaeger.api.entities.impl.EllipseEntity
Set the vertical radius of the ellipse.
setRelativeScrollPosition(double, double) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the scroll position of the scene to the relative x and y-value provided.
setRootPane(Pane) - Method in class com.github.hanyaeger.api.entities.CompositeEntity
 
setRootPane(Pane) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Set the root pane to which this YaegerEntity is added.
setRotate(double) - Method in interface com.github.hanyaeger.api.entities.Rotatable
Set the rotation of the YaegerEntity to the specified value.
setRotation(double) - Method in class com.github.hanyaeger.core.entities.motion.InitializationBuffer
Set the value of rotation.
setRotationSpeed(double) - Method in interface com.github.hanyaeger.api.entities.ContinuousRotatable
Set the angle at which this YaegerEntity will bew rotated at each update.
setRotationSpeed(double) - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
setRotationSpeed(double) - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
setRotationSpeed(double) - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
setRotationSpeed(double) - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
setRotationSpeed(double) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
setRotationSpeed(double) - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
setSaturation(double) - Method in interface com.github.hanyaeger.core.Effectable
Set the saturation of the YaegerScene or YaegerEntity.
setSaturation(double) - Method in class com.github.hanyaeger.core.YaegerGameObject
 
setSceneCollectionFactory(SceneCollectionFactory) - Method in class com.github.hanyaeger.core.YaegerStage
Set the SceneCollectionFactory to be used whenever a SceneCollection has to be created.
setSceneFactory(SceneFactory) - Method in class com.github.hanyaeger.api.scenes.StaticScene
Set the SceneFactory that should be used to create a Scene.
setSceneFactory(SceneFactory) - Method in class com.github.hanyaeger.core.YaegerStage
Set the SceneFactory to be used whenever a Scene has to be created.
setScrollPosition(Coordinate2D) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the scroll position of the scene centered on the given Coordinate2D.
setShape(T) - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Set the actual Shape of type ShapeEntity.
setSize(Size) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the Size (e.g.
setSize(Size) - Method in class com.github.hanyaeger.api.YaegerGame
Set the Size, being the width and height of the game.
setSize(Size) - Method in class com.github.hanyaeger.core.YaegerStage
Set the Size, being the width and height of the game.
setSpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.BufferedMovable
 
setSpeed(double) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
setSpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.MotionModifier
Set the speed.
setSpeed(double) - Method in interface com.github.hanyaeger.core.entities.motion.Movable
 
setSplashScreenFactory(SplashScreenFactory) - Method in class com.github.hanyaeger.core.SceneCollection
Set the SplashScreenFactory to be used.
setSpriteAnimationDelegateFactory(SpriteAnimationDelegateFactory) - Method in class com.github.hanyaeger.api.entities.impl.SpriteEntity
Set the SpriteAnimationDelegateFactory to be used.
setStage(Stage) - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
setStage(Stage) - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set the Stage on this YaegerScene.
setStrokeColor(Color) - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Set the color of the stroke to be used.
setStrokeWidth(double) - Method in class com.github.hanyaeger.core.entities.ShapeEntity
Set the width of the stroke to be used.
setSupplier(EntitySupplier) - Method in class com.github.hanyaeger.api.entities.EntitySpawner
Set the EntitySupplier to be used.
setText(String) - Method in class com.github.hanyaeger.api.entities.impl.TextEntity
Set the String that should be shown.
setTextFactory(TextFactory) - Method in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
 
setTileFactory(TileFactory) - Method in class com.github.hanyaeger.api.scenes.TileMap
Set the TileFactory to be used.
setTitle(String) - Method in class com.github.hanyaeger.core.YaegerStage
Set the title of the Game.
setup(Pane) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set up the Pane belonging to this BackgroundDelegate.
setup(Pane) - Method in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
Set up the Pane belonging to this CoordinateGridDelegate.
setup(Pane, Scene) - Method in class com.github.hanyaeger.core.entities.Debugger
Set up the Debugger on the given Pane.
setup(Scene, KeyListener, YaegerConfig) - Method in class com.github.hanyaeger.core.scenes.delegates.KeyListenerDelegate
Setup this KeyListenerDelegate for a specific Scene and KeyListener.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
Set the Updater to be used.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
Set the Updater to be used.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
Set the Updater to be used.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
Set the Updater to be used.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
Set the Updater to be used.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
Set the Updater to be used.
setUpdater(Updater) - Method in class com.github.hanyaeger.api.scenes.DynamicScene
Set the Updater that should be used.
setupEntities() - Method in class com.github.hanyaeger.api.entities.CompositeEntity
Implement this method to set up all instances of YaegerEntity that should be added to the CompositeEntity before activation.
setupEntities() - Method in class com.github.hanyaeger.api.scenes.TileMap
The lifecycle method setupEntities() should be used to add the instances of YaegerEntity that should be used in this TileMap.
setupEntities() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Use this method to set up all instances of YaegerEntity that should be added to the YaegerScene before activation.
setupEntities() - Method in class com.github.hanyaeger.core.scenes.splash.SplashScene
 
setupEntitySpawners() - Method in interface com.github.hanyaeger.api.EntitySpawnerContainer
Only instances of EntitySpawner that are registered with the method EntitySpawnerContainer.addEntitySpawner(EntitySpawner) within this method are registered and will receive an animation update.
setupGame() - Method in class com.github.hanyaeger.api.YaegerGame
Use this method to call the methods responsible for setting up the Yaeger Game.
setupScene() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Set up the YaegerScene.
setupScene() - Method in class com.github.hanyaeger.core.scenes.splash.SplashScene
 
setupScenes() - Method in class com.github.hanyaeger.api.YaegerGame
Use this method to add the instances of YaegerScene that make up the Game.
setupTileMaps() - Method in interface com.github.hanyaeger.api.scenes.TileMapContainer
Only instances of Timer that are registered with the method TileMapContainer.addTileMap(TileMap) within this method are registered and will receive an animation update.
setupTimers() - Method in interface com.github.hanyaeger.api.TimerContainer
Only instances of Timer that are registered with the method TimerContainer.addTimer(Timer) within this method are registered and will receive an animation update.
setupTimers() - Method in class com.github.hanyaeger.core.scenes.splash.SplashScene
 
setVerticalRelativeScrollPosition(double) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the vertical scroll position of the scene to a relative value.
setVerticalScrollPosition(double) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the vertical scroll position of the scene.
setViewOrder(double) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Set the viewOrder of this YaegerEntity.
setViewPortEntitySupplier(EntitySupplier) - Method in class com.github.hanyaeger.api.scenes.ScrollableDynamicScene
Set the EntitySupplier that should be used for the view port layer.
setVisible(boolean) - Method in class com.github.hanyaeger.api.entities.YaegerEntity
Change the visibility of this YaegerEntity.
setVolume(double) - Method in class com.github.hanyaeger.api.media.SoundClip
Set the default volume level.
setVolume(double) - Method in class com.github.hanyaeger.core.media.BackgroundAudioMediaPlayer
Sets the audio playback volume.
setVolume(double) - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Set the volume of the background audio.
setWidth(double) - Method in class com.github.hanyaeger.api.entities.impl.RectangleEntity
Set the width of the rectangle.
shape - Variable in class com.github.hanyaeger.core.entities.ShapeEntity
The actual Shape of type ShapeEntity to be used
ShapeEntity<T> - Class in com.github.hanyaeger.core.entities
The ShapeEntity is the abstract super class of all Entities that encapsulate a JavaFX Shape.
ShapeEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.core.entities.ShapeEntity
Instantiate a new ShapeEntity for the given Coordinate2D.
showBoundingBox() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns the value of the showBoundingBox record component.
showDebug() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns the value of the showDebug record component.
showGrid() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns the value of the showGrid record component.
showSplash() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns the value of the showSplash record component.
size() - Method in record class com.github.hanyaeger.api.entities.impl.CustomFont
Returns the value of the size record component.
size() - Method in class com.github.hanyaeger.core.repositories.AudioRepository
Returns the number of key-value mappings in this map.
size() - Method in class com.github.hanyaeger.core.repositories.ImageRepository
Returns the number of key-value mappings in this map.
Size - Record Class in com.github.hanyaeger.api
A Size encapsulates the width and height.
Size(double) - Constructor for record class com.github.hanyaeger.api.Size
Creates a new instance of Size, where the Size is rectangular shaped, this the width and height have the same value.
Size(double, double) - Constructor for record class com.github.hanyaeger.api.Size
Creates an instance of a Size record class.
SoundClip - Class in com.github.hanyaeger.api.media
A SoundClip encapsulates a mp3 audio file.
SoundClip(String) - Constructor for class com.github.hanyaeger.api.media.SoundClip
Instantiate a new SoundClip for the given file, which should be played only once.
SoundClip(String, int) - Constructor for class com.github.hanyaeger.api.media.SoundClip
Instantiate a new SoundClip for the given file, which should be played for the given amount provided of cycleCount.
spawn(YaegerEntity) - Method in class com.github.hanyaeger.api.entities.EntitySpawner
Spawn an YaegerEntity.
spawnEntities() - Method in class com.github.hanyaeger.api.entities.EntitySpawner
This method is called after each interval in milliseconds as passed through the constructor of this EntitySpawner.
SpeedProvider - Interface in com.github.hanyaeger.core.entities.motion
A SpeedProvider exposes a method to acquire the speed.
SplashScene - Class in com.github.hanyaeger.core.scenes.splash
A Splash Screen, being an instance of YaegerScene that will be shown a given number of milliseconds at the start of a YaegerGame.
SplashScreenFactory - Class in com.github.hanyaeger.core.scenes.splash
The factory to be used for creating instances of SplashScene.
SplashScreenFactory() - Constructor for class com.github.hanyaeger.core.scenes.splash.SplashScreenFactory
 
SpriteAnimationDelegate - Class in com.github.hanyaeger.core.entities
A SpriteAnimationDelegate holds all responsibility related to Sprites that contain multiple images.
SpriteAnimationDelegate(ImageView, int, int) - Constructor for class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Create a new SpriteAnimationDelegate for the given ImageView and number of rows and columns.
SpriteAnimationDelegateFactory - Class in com.github.hanyaeger.core.factories.image
A SpriteAnimationDelegateFactory is responsible for creating an instance of a SpriteAnimationDelegate.
SpriteAnimationDelegateFactory() - Constructor for class com.github.hanyaeger.core.factories.image.SpriteAnimationDelegateFactory
 
SpriteEntity - Class in com.github.hanyaeger.api.entities.impl
A SpriteEntity is a YaegerEntity that is represented by an Image.
SpriteEntity(String, Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.SpriteEntity
Instantiate a new SpriteEntity for an image with the given resource.
SpriteEntity(String, Coordinate2D, int, int) - Constructor for class com.github.hanyaeger.api.entities.impl.SpriteEntity
Instantiate a new SpriteEntity for a given image.
SpriteEntity(String, Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.entities.impl.SpriteEntity
Instantiate a new SpriteEntity for a given image.
SpriteEntity(String, Coordinate2D, Size, int, int) - Constructor for class com.github.hanyaeger.api.entities.impl.SpriteEntity
Instantiate a new SpriteEntity for a given image.
start(Stage) - Method in class com.github.hanyaeger.api.YaegerGame
 
StaticScene - Class in com.github.hanyaeger.api.scenes
A StaticScene is the abstract superclass of all scenes that do not require a Game Loop.
StaticScene() - Constructor for class com.github.hanyaeger.api.scenes.StaticScene
 
StatisticsObserver - Interface in com.github.hanyaeger.core.entities
A StatisticsObserver will function as the Observer from the Observable-pattern, for changes in the EntityCollectionStatistics.
stop() - Method in class com.github.hanyaeger.api.media.SoundClip
Stop playing the file.
stopBackgroundAudio() - Method in class com.github.hanyaeger.api.scenes.StaticScene
 
stopBackgroundAudio() - Method in interface com.github.hanyaeger.api.scenes.YaegerScene
Stop playing the background audio.
stopBackgroundAudio() - Method in class com.github.hanyaeger.api.YaegerGame
Stop playing the background audio.
stopBackgroundAudio() - Method in class com.github.hanyaeger.core.media.BackgroundAudioMediaPlayer
Stop playing the background audio.
stopBackgroundAudio() - Method in class com.github.hanyaeger.core.scenes.delegates.BackgroundDelegate
Stop playing the background audio.
subtract(Coordinate2D) - Method in class com.github.hanyaeger.api.Coordinate2D
Return a Coordinate2D with the coordinates of the specified point subtracted from the coordinates of this Coordinate2D.

T

tearDown(Scene) - Method in class com.github.hanyaeger.core.scenes.delegates.KeyListenerDelegate
Tear down this KeyListenerDelegate by removing the listeners from the Scene.
TEXT_COLOR - Static variable in class com.github.hanyaeger.core.scenes.delegates.CoordinateGridDelegate
 
TextEntity - Class in com.github.hanyaeger.api.entities.impl
A TextEntity can be used to display a line of text on a YaegerScene.
TextEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.impl.TextEntity
Create a new empty TextEntity on the given initialLocation.
TextEntity(Coordinate2D, String) - Constructor for class com.github.hanyaeger.api.entities.impl.TextEntity
Create a new TextEntity on the given Point2D for the given text.
TextFactory - Class in com.github.hanyaeger.core.factories
An LineFactory should be used for creating instance of Line.
TextFactory() - Constructor for class com.github.hanyaeger.core.factories.TextFactory
 
TileFactory - Class in com.github.hanyaeger.core.factories
The TileFactory should be used for creating instances of YaegerEntity that will be part of a TileMap.
TileFactory() - Constructor for class com.github.hanyaeger.core.factories.TileFactory
 
TileMap - Class in com.github.hanyaeger.api.scenes
A TileMap encapsulate a two-dimensional map of instances of YaegerEntity, which should be added to a YaegerScene.
TileMap() - Constructor for class com.github.hanyaeger.api.scenes.TileMap
Create a new TileMap that takes up the full width and height of the YaegerScene.
TileMap(Coordinate2D, Size) - Constructor for class com.github.hanyaeger.api.scenes.TileMap
Create a new TileMap with the given width and height, placed on the given x and y.
TileMapContainer - Interface in com.github.hanyaeger.api.scenes
Implementing this interface exposes the TileMapContainer.addTileMap(TileMap) method.
TimeableAnimationTimer - Class in com.github.hanyaeger.core.factories.animationtimer
An AnimationTimer that calls its handle() method on the given interval, and not the default on each frame.
TimeableAnimationTimer(long) - Constructor for class com.github.hanyaeger.core.factories.animationtimer.TimeableAnimationTimer
Creat a new TimeableAnimationTimer for the given interval time in milliseconds.
TimeableAnimationTimerHandler - Interface in com.github.hanyaeger.core.factories.animationtimer
A Functional Interface to be used for the handler of a AnimationTimer.
Timer - Class in com.github.hanyaeger.api
The abstract superclass of all timers that are available for both YaegerScene and YaegerEntity.
Timer(long) - Constructor for class com.github.hanyaeger.api.Timer
Create a new instance of Timer for the given interval in milliseconds.
TimerContainer - Interface in com.github.hanyaeger.api
An TimerContainer enables a YaegerScene and YaegerEntity to use instances of Timer.
TimerListProvider - Interface in com.github.hanyaeger.core
Implementing the TimerListProvider interface guarantees that a List of instances of Timer is available.
TOP - Enum constant in enum class com.github.hanyaeger.api.scenes.SceneBorder
The top of the YaegerScene.
TOP_CENTER - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the top-center point of the bounding box as the Anchor Point.
TOP_LEFT - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the top-left corner of the bounding box as the Anchor Point.
TOP_RIGHT - Enum constant in enum class com.github.hanyaeger.api.AnchorPoint
Use the top-right corner of the bounding box as the Anchor Point.
toString() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimation
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.api.entities.FiniteAnimationWithCallBack
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.api.entities.impl.CustomFont
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimation
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.api.entities.LinkedAnimationWithCallBack
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.api.entities.LoopingAnimation
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.api.Size
Returns a string representation of this record class.
toString() - Method in record class com.github.hanyaeger.core.YaegerConfig
Returns a string representation of this record class.
transferCoordinatesToNode() - Method in class com.github.hanyaeger.api.entities.CompositeEntity
Because the Group encapsulates the child nodes and its BoundingBox depends on the space and location of those child nodes, first the child nodes receive their coordinates and transformations.
transferCoordinatesToNode() - Method in class com.github.hanyaeger.api.entities.YaegerEntity
 
transferCoordinatesToNode() - Method in interface com.github.hanyaeger.core.entities.Placeable
Transfer the x and y-coordinate of this YaegerEntity to its JavaFX Node and apply the requested transformations.

U

unQueueAnimation() - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Call this method to un-queue the Animation that is currently queued.
unQueueAnimation(Animation) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
Call this method to un-queue the specific Animation, if it is currently queued.
UP - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The upward direction, of which the numeric value is 180 degrees.
UP_LEFT - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The diagonal direction to the left up, of which the numeric value is 225 degrees.
UP_RIGHT - Enum constant in enum class com.github.hanyaeger.api.entities.Direction
The diagonal direction to the right up, of which the numeric value is 135 degrees.
Updatable - Interface in com.github.hanyaeger.core
Implement this interface to be updated every cycle of the game loop.
UpdatableProvider - Annotation Interface in com.github.hanyaeger.core.annotations
A method annotated with UpdatableProvider should return an Updatable and will automatically be called during activation of an YaegerEntity or YaegerScene to gathers all objects that contain an Updatable.update(long) method that should be called at each Game world update.
update(long) - Method in class com.github.hanyaeger.api.entities.DynamicCompositeEntity
 
update(long) - Method in class com.github.hanyaeger.api.entities.impl.DynamicCircleEntity
 
update(long) - Method in class com.github.hanyaeger.api.entities.impl.DynamicEllipseEntity
 
update(long) - Method in class com.github.hanyaeger.api.entities.impl.DynamicRectangleEntity
 
update(long) - Method in class com.github.hanyaeger.api.entities.impl.DynamicSpriteEntity
 
update(long) - Method in class com.github.hanyaeger.api.entities.impl.DynamicTextEntity
 
update(long) - Method in class com.github.hanyaeger.api.scenes.DynamicScene
 
update(long) - Method in class com.github.hanyaeger.core.entities.EntityCollection
Perform all operations required during one cycle of the Game Loop, being: Collect garbage All EntityCollection that have been marked as Garbage will be removed.
update(long) - Method in class com.github.hanyaeger.core.entities.SpriteAnimationDelegate
 
update(long) - Method in interface com.github.hanyaeger.core.Updatable
The update() method is called each frame.
update(long) - Method in class com.github.hanyaeger.core.Updater
 
update(EntityCollectionStatistics, long) - Method in class com.github.hanyaeger.core.entities.Debugger
Update the content of the Debugger.
update(EntityCollectionStatistics, long) - Method in interface com.github.hanyaeger.core.entities.StatisticsObserver
Is called by the observed EntityCollection.
UpdateDelegator - Interface in com.github.hanyaeger.core
An Updatable that delegates the Updatable.update(long) to an Updater.
UpdateExposer - Interface in com.github.hanyaeger.api
An UpdateExposer can be applied to any dynamic YaegerEntity or YaegerScene and makes it possible to explicitly use the GWU.
updateLocation() - Method in interface com.github.hanyaeger.core.entities.motion.Movable
Return the Updatable to be called on each Game World Update.
updateLocation(Point2D) - Method in interface com.github.hanyaeger.core.entities.motion.LocationUpdater
Perform an update.
updateLocation(Point2D) - Method in class com.github.hanyaeger.core.entities.motion.MotionApplier
 
Updater - Class in com.github.hanyaeger.core
An Updater contains a List of Updatable to which the update method will be delegated.
Updater() - Constructor for class com.github.hanyaeger.core.Updater
 

V

valueOf(double) - Static method in enum class com.github.hanyaeger.api.entities.Direction
Return the enumeration of type Direction for the given numeric value.
valueOf(String) - Static method in enum class com.github.hanyaeger.api.AnchorPoint
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.hanyaeger.api.entities.Direction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.hanyaeger.api.scenes.SceneBorder
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.hanyaeger.api.AnchorPoint
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.hanyaeger.api.entities.Direction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.hanyaeger.api.scenes.SceneBorder
Returns an array containing the constants of this enum class, in the order they are declared.
VIEW_ORDER_COORDINATE_GRID - Static variable in class com.github.hanyaeger.core.ViewOrders
The default value for the viewOrder for the Coordinate grid that is shown when the commandline option --showGrid is being used.
VIEW_ORDER_DEBUGGER - Static variable in class com.github.hanyaeger.core.ViewOrders
Since the debugger should be visible in all cases, it should have an exceptionally low view order.
VIEW_ORDER_ENTITY_DEFAULT - Static variable in class com.github.hanyaeger.core.ViewOrders
The default value for the viewOrder for instances of YaegerEntity.
VIEW_ORDER_ENTITY_DEFAULT_BEHIND - Static variable in class com.github.hanyaeger.core.ViewOrders
The default value for the viewOrder for instances of YaegerEntity that are part of a TileMap.
VIEW_ORDER_ENTITY_STICKY - Static variable in class com.github.hanyaeger.core.ViewOrders
The default value for the viewOrder for instances of YaegerEntity.
VIEW_ORDER_SCROLLPANE - Static variable in class com.github.hanyaeger.core.ViewOrders
In case of a ScrollableDynamicScene, the ScrollPane should be placed behind the Pane that is to be used for sticky instances of Node.
VIEW_ORDER_STICKYPANE - Static variable in class com.github.hanyaeger.core.ViewOrders
In case of a ScrollableDynamicScene, the ScrollPane should be placed behind the Pane that is to be used for sticky instances of Node.
ViewOrders - Class in com.github.hanyaeger.core
All constants that are related to the view order of any Node that is to be part of a YaegerGame.

W

watchForBoundaryCrossing() - Method in interface com.github.hanyaeger.api.entities.SceneBorderCrossingWatcher
Return an Updatable that checks if any of the boundaries has been crossed on each Updatable.update(long)
watchForBoundaryTouching() - Method in interface com.github.hanyaeger.api.entities.SceneBorderTouchingWatcher
Return an Updatable that checks if any of the boundaries has been touched on each Updatable.update(long)
width() - Method in record class com.github.hanyaeger.api.Size
Returns the value of the width record component.

Y

YaegerAnimationTimer - Class in com.github.hanyaeger.core
A specific implementation of AnimationTimer that limits the call to YaegerAnimationTimer.handle(long) to 60 times per second.
YaegerAnimationTimer(boolean) - Constructor for class com.github.hanyaeger.core.YaegerAnimationTimer
Create a new YaegerAnimationTimer, which adds the option of maximizing the timing interval to 60 times per second, as opposed to the default AnimationTimer.
YaegerCommandLineParser - Class in com.github.hanyaeger.core
The commandline parser will parse the String[] provided as command line arguments during start up to a YaegerConfig.
YaegerCommandLineParser() - Constructor for class com.github.hanyaeger.core.YaegerCommandLineParser
 
YaegerConfig - Record Class in com.github.hanyaeger.core
An encapsulation of the various configuration settings that can be applied to a Yaeger game at start-up.
YaegerConfig(boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for record class com.github.hanyaeger.core.YaegerConfig
Creates an instance of a YaegerConfig record class.
YaegerEntity - Class in com.github.hanyaeger.api.entities
A YaegerEntity is the base class for all things that can be drawn on a YaegerScene.
YaegerEntity(Coordinate2D) - Constructor for class com.github.hanyaeger.api.entities.YaegerEntity
Create a new YaegerEntity on the given Coordinate2D.
YaegerGame - Class in com.github.hanyaeger.api
YaegerGame is the base class that must be extended to create a Yaeger game.
YaegerGame() - Constructor for class com.github.hanyaeger.api.YaegerGame
 
YaegerGameObject - Class in com.github.hanyaeger.core
The abstract base class of both the YaegerEntity and StaticScene and contains the shared behaviour.
YaegerGameObject() - Constructor for class com.github.hanyaeger.core.YaegerGameObject
 
YaegerScene - Interface in com.github.hanyaeger.api.scenes
A YaegerScene encapsulates a scene or level from a Yaeger Game.
YaegerStage - Class in com.github.hanyaeger.core
A YaegerStage encapsulates an JavaFX Stage.
YaegerStage(YaegerGame, Stage, YaegerConfig) - Constructor for class com.github.hanyaeger.core.YaegerStage
Create a new YaegerStage with the given parameters.
A B C D E F G H I K L M N O P Q R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form