Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X Y 

A

accept(Throwable) - Method in interface com.almasb.fxgl.service.ExceptionHandler
Equivalent to handle(e).
ACHIEVED - Static variable in class com.almasb.fxgl.gameplay.AchievementEvent
 
ACHIEVEMENT_MANAGER - Static variable in interface com.almasb.fxgl.service.ServiceType
 
AchievementEvent - Class in com.almasb.fxgl.gameplay
Occurs on achievement unlocked.
AchievementEvent(Achievement) - Constructor for class com.almasb.fxgl.gameplay.AchievementEvent
 
AchievementEvent(EventType<? extends AchievementEvent>, Achievement) - Constructor for class com.almasb.fxgl.gameplay.AchievementEvent
 
AchievementListener - Interface in com.almasb.fxgl.gameplay
Marks a service that wants to listen for achievement events.
AchievementProgressEvent - Class in com.almasb.fxgl.gameplay
Fired when a numeric value based achievement has made some progress.
AchievementProgressEvent(Achievement, double, double) - Constructor for class com.almasb.fxgl.gameplay.AchievementProgressEvent
 
activeProperty() - Method in class com.almasb.fxgl.scene.FXGLScene
If a scene is active it is being shown by the display.
addAction(UserAction, KeyCode) - Method in interface com.almasb.fxgl.service.Input
Bind given action to a keyboard key.
addAction(UserAction, KeyCode, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Bind given action to a keyboard key with special modifier key.
addAction(UserAction, MouseButton) - Method in interface com.almasb.fxgl.service.Input
Bind given action to a mouse button with special modifier key.
addAction(UserAction, MouseButton, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Bind given action to a mouse button with special modifier key.
AddCollisionHandler - Annotation Type in com.almasb.fxgl.annotation
Indicates that a class that extends CollisionHandler will be automatically added to physics world's collision handlers.
addCollisionHandler(CollisionHandler) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Registers a collision handler.
addDataParser(Class<T>, DataParser<T>) - Method in interface com.almasb.fxgl.service.Net
 
addEventHandler(EventType<T>, EventHandler<? super T>) - Method in interface com.almasb.fxgl.service.Input
Add JavaFX event handler to handle events manually.
addEventTrigger(<any>) - Method in class com.almasb.fxgl.entity.GameWorld
Add event trigger to the world.
addExitListener(ExitListener) - Method in class com.almasb.fxgl.app.GameApplication
 
addGameView(EntityView) - Method in class com.almasb.fxgl.scene.GameScene
Add a view to the game root.
addHitBox(HitBox) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Add a hit (collision) bounding box.
addInputMapping(InputMapping) - Method in interface com.almasb.fxgl.service.Input
Add input mapping.
addNode(Node) - Method in class com.almasb.fxgl.entity.EntityView
Add a child node to this view.
addPlayStateListener(StateListener) - Method in class com.almasb.fxgl.app.GameApplication
 
addQuest(Quest) - Method in interface com.almasb.fxgl.service.QuestService
Add given quest to service.
addServiceType(ServiceType<?>) - Method in class com.almasb.fxgl.settings.GameSettings
Register a custom service with FXGL.
addStateListener(StateListener) - Method in class com.almasb.fxgl.app.State
 
addUI(UI) - Method in class com.almasb.fxgl.scene.GameScene
 
addUINode(Node) - Method in class com.almasb.fxgl.scene.FXGLMenu
Adds a UI node.
addUINode(Node) - Method in class com.almasb.fxgl.scene.GameScene
Add a node to the UI overlay.
addUINodes(Node...) - Method in class com.almasb.fxgl.scene.GameScene
Add nodes to the UI overlay.
addUpdateListener(UpdateListener) - Method in class com.almasb.fxgl.app.GameApplication
 
angleProperty() - Method in class com.almasb.fxgl.entity.component.RotationComponent
 
AnimatedTexture - Class in com.almasb.fxgl.texture
Represents an animated texture.
AnimationBuilder - Class in com.almasb.fxgl.entity.animation
A convenient builder for standard (translate, rotate, scale) animations.
AnimationBuilder() - Constructor for class com.almasb.fxgl.entity.animation.AnimationBuilder
 
animationBuilder() - Static method in class com.almasb.fxgl.entity.Entities
 
AnimationChannel - Interface in com.almasb.fxgl.texture
Represents one of the animation channels from sprite sheet.
ANY - Static variable in class com.almasb.fxgl.entity.EntityEvent
 
ANY - Static variable in class com.almasb.fxgl.gameplay.AchievementEvent
 
ANY - Static variable in class com.almasb.fxgl.gameplay.NotificationEvent
 
ANY - Static variable in class com.almasb.fxgl.saving.LoadEvent
 
ANY - Static variable in class com.almasb.fxgl.saving.SaveEvent
 
app - Variable in class com.almasb.fxgl.scene.FXGLMenu
 
appendCSS(CSS) - Method in class com.almasb.fxgl.scene.FXGLScene
 
ApplicationModule - Class in com.almasb.fxgl.app
Module that binds services with their providers.
apply(T, U, V) - Method in interface com.almasb.fxgl.util.TriFunction
 
applyAngularImpulse(float) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply an angular impulse.
applyBodyAngularImpulse(float) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply an angular impulse.
applyBodyForce(Vec2, Vec2) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply a force at a world point.
applyBodyForceToCenter(Vec2) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply a force to the center of mass.
applyBodyLinearImpulse(Vec2, Vec2, boolean) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply an impulse at a point.
applyBodyTorque(float) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply a torque.
applyForce(Point2D, Point2D) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply a force at a world point.
applyForceToCenter(Point2D) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply a force to the center of mass.
applyLinearImpulse(Point2D, Point2D, boolean) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply an impulse at a point.
applyTorque(float) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Apply a torque.
appMode - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
AppStateMachine - Class in com.almasb.fxgl.app
Initializes application states.
area() - Method in interface com.almasb.fxgl.texture.AnimationChannel
Area to be used to select a sub-texture from a sprite sheet.
ASSET_LOADER - Static variable in interface com.almasb.fxgl.service.ServiceType
 
AssetLoader - Interface in com.almasb.fxgl.service
Handles all resource (asset) loading operations.
asString() - Method in interface com.almasb.fxgl.entity.RenderLayer
 
async(Callable<T>) - Method in interface com.almasb.fxgl.service.Executor
Instantly starts a non-blocking async task.
async(Runnable) - Method in interface com.almasb.fxgl.service.Executor
Instantly starts a non-blocking async task.
at(double, double) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
at(Point2D) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
at(Vec2) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
AUDIO_PLAYER - Static variable in interface com.almasb.fxgl.service.ServiceType
 
AudioPlayer - Interface in com.almasb.fxgl.service
General audio player service that supports playback of sound and music objects.

B

BACKGROUND - Static variable in interface com.almasb.fxgl.entity.RenderLayer
Render layer for background.
bbox(HitBox) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
beginContact(Contact) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
bindServices() - Method in class com.almasb.fxgl.app.ApplicationModule
Can be overridden to provide own services or mock.
bindSize(DoubleProperty, DoubleProperty, DoubleProperty) - Method in class com.almasb.fxgl.scene.FXGLScene
 
bindX(DoubleProperty) - Method in class com.almasb.fxgl.physics.HitBox
Bind to x property of entity.
bindY(DoubleProperty) - Method in class com.almasb.fxgl.physics.HitBox
Bind to y property of entity.
blockHeight() - Method in interface com.almasb.fxgl.entity.TextEntityFactory
 
blockWidth() - Method in interface com.almasb.fxgl.entity.TextEntityFactory
 
BoundingBoxComponent - Class in com.almasb.fxgl.entity.component
Component that adds bounding box information to an entity.
BoundingBoxComponent(HitBox...) - Constructor for class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
BoundingShape - Class in com.almasb.fxgl.physics
Defines bounding shapes to be used for hit boxes.
box(double, double) - Static method in class com.almasb.fxgl.physics.BoundingShape
Constructs new rectangular bounding shape with given width and height.
build() - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
Finishes building entity.
buildAndAttach(GameWorld) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
Finishes building the entity and attaches it to given world.
builder() - Static method in class com.almasb.fxgl.entity.Entities
 

C

cache() - Method in interface com.almasb.fxgl.service.AssetLoader
Pre-loads all textures / sounds / music / text / fonts and binary data from their respective folders.
callFunction(String, Object...) - Method in class com.almasb.fxgl.parser.JavaScriptParser
Invokes a JS function.
canGoOffscreen() - Method in class com.almasb.fxgl.ui.InGameWindow
 
canShowCloseDialog() - Method in class com.almasb.fxgl.app.AppStateMachine
 
CCTRMenu - Class in com.almasb.fxgl.scene.menu
 
CCTRMenu(GameApplication, MenuType) - Constructor for class com.almasb.fxgl.scene.menu.CCTRMenu
 
centerLocal() - Method in class com.almasb.fxgl.physics.HitBox
 
centerText(Text) - Method in interface com.almasb.fxgl.service.UIFactory
 
centerText(Text, double, double) - Method in interface com.almasb.fxgl.service.UIFactory
 
centerTextBind(Text) - Method in interface com.almasb.fxgl.service.UIFactory
Binds text to application center, i.e.
centerTextBind(Text, double, double) - Method in interface com.almasb.fxgl.service.UIFactory
Binds text to given center point, i.e.
centerTextX(Text, double, double) - Method in interface com.almasb.fxgl.service.UIFactory
 
centerTextY(Text, double, double) - Method in interface com.almasb.fxgl.service.UIFactory
 
centerWorld(double, double) - Method in class com.almasb.fxgl.physics.HitBox
 
chain(Point2D...) - Static method in class com.almasb.fxgl.physics.BoundingShape
Constructs new closed chain shaped bounding shape.
checkCollision(BoundingBoxComponent) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Checks for collision with another bounding box.
circle(double) - Static method in class com.almasb.fxgl.physics.BoundingShape
Constructs new circular bounding shape with given radius.
CircularMovementControl - Class in com.almasb.fxgl.entity.control
Control that moves entity in a circle.
CircularMovementControl(double, double) - Constructor for class com.almasb.fxgl.entity.control.CircularMovementControl
 
clearAll() - Method in interface com.almasb.fxgl.service.Input
Clears all active actions.
clearCache() - Method in interface com.almasb.fxgl.service.AssetLoader
Release all cached assets.
clearChildren() - Method in class com.almasb.fxgl.entity.EntityView
Removes all attached nodes.
clearCSS() - Method in class com.almasb.fxgl.scene.FXGLScene
 
clearEffect() - Method in class com.almasb.fxgl.scene.FXGLScene
Removes any effects applied to the scene.
clearHitBoxes() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Remove all hit boxes.
close() - Method in class com.almasb.fxgl.ui.InGameWindow
 
closeConfirmation - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
CollidableComponent - Class in com.almasb.fxgl.entity.component
Marks an entity as collidable.
CollidableComponent(boolean) - Constructor for class com.almasb.fxgl.entity.component.CollidableComponent
 
CollidableComponent() - Constructor for class com.almasb.fxgl.entity.component.CollidableComponent
 
COLLISION - Static variable in class com.almasb.fxgl.physics.CollisionResult
Constant for reporting collision.
CollisionHandler - Class in com.almasb.fxgl.physics
Handler for a collision that occurred between two entities.
CollisionHandler(Object, Object) - Constructor for class com.almasb.fxgl.physics.CollisionHandler
The order of types determines the order of entities in callbacks.
CollisionResult - Class in com.almasb.fxgl.physics
Data structure for holding info about collision result.
CollisionResult() - Constructor for class com.almasb.fxgl.physics.CollisionResult
 
com.almasb.fxgl.annotation - package com.almasb.fxgl.annotation
 
com.almasb.fxgl.app - package com.almasb.fxgl.app
 
com.almasb.fxgl.app.listener - package com.almasb.fxgl.app.listener
 
com.almasb.fxgl.effect - package com.almasb.fxgl.effect
 
com.almasb.fxgl.entity - package com.almasb.fxgl.entity
 
com.almasb.fxgl.entity.animation - package com.almasb.fxgl.entity.animation
 
com.almasb.fxgl.entity.component - package com.almasb.fxgl.entity.component
 
com.almasb.fxgl.entity.control - package com.almasb.fxgl.entity.control
 
com.almasb.fxgl.gameplay - package com.almasb.fxgl.gameplay
 
com.almasb.fxgl.input - package com.almasb.fxgl.input
 
com.almasb.fxgl.parser - package com.almasb.fxgl.parser
 
com.almasb.fxgl.physics - package com.almasb.fxgl.physics
 
com.almasb.fxgl.saving - package com.almasb.fxgl.saving
 
com.almasb.fxgl.scene - package com.almasb.fxgl.scene
 
com.almasb.fxgl.scene.menu - package com.almasb.fxgl.scene.menu
 
com.almasb.fxgl.service - package com.almasb.fxgl.service
 
com.almasb.fxgl.settings - package com.almasb.fxgl.settings
 
com.almasb.fxgl.texture - package com.almasb.fxgl.texture
 
com.almasb.fxgl.ui - package com.almasb.fxgl.ui
 
com.almasb.fxgl.util - package com.almasb.fxgl.util
 
computeFrameHeight() - Method in interface com.almasb.fxgl.texture.AnimationChannel
Computes frame height based on the area height.
computeFrameTime() - Method in interface com.almasb.fxgl.texture.AnimationChannel
Computes time per each frame in this animation channel by dividing the duration by number of frames.
computeFrameWidth() - Method in interface com.almasb.fxgl.texture.AnimationChannel
Computes frame width based on the area width and number of frames.
computePrefWidth(double) - Method in class com.almasb.fxgl.ui.FXGLButton
 
computePrefWidth(double) - Method in class com.almasb.fxgl.ui.FXGLChoiceBox
 
computeViewport(int) - Method in interface com.almasb.fxgl.texture.AnimationChannel
Computes the viewport for given frame.
configure() - Method in class com.almasb.fxgl.app.ApplicationModule
 
confirmationDialog(String, Consumer<Boolean>) - Method in interface com.almasb.fxgl.service.DialogFactory
 
connectMultiplayerTask(String) - Method in interface com.almasb.fxgl.service.Net
 
contentRoot - Variable in class com.almasb.fxgl.scene.FXGLMenu
 
copy() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
copy() - Method in class com.almasb.fxgl.entity.component.CollidableComponent
 
copy() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
copy() - Method in class com.almasb.fxgl.entity.component.RotationComponent
 
copy() - Method in class com.almasb.fxgl.entity.component.SelectableComponent
 
copy() - Method in class com.almasb.fxgl.entity.component.TypeComponent
 
copy() - Method in class com.almasb.fxgl.texture.Texture
Call this to create a new texture if you are planning to use the same image as graphics for multiple entities.
copyFor(Object, Object) - Method in class com.almasb.fxgl.physics.CollisionHandler
Returns a copy of the collision handler with different entity types.
createActionButton(String, Runnable) - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createActionButton(String, Runnable) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
Creates a new button with given name that performs given action on click/press.
createActionButton(String, Runnable) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createActionButton(String, Runnable) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
Creates a new button with given name that performs given action on click/press.
createBackground(double, double) - Method in class com.almasb.fxgl.scene.FXGLMenu
Create menu background.
createBackground(double, double) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
createBackground(double, double) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createBackground(double, double) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
 
createContentAchievements() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentAudio() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentButton(String, Supplier<FXGLMenu.MenuContent>) - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentButton(String, Supplier<FXGLMenu.MenuContent>) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
Creates a new button with given name that sets given content on click/press.
createContentButton(String, Supplier<FXGLMenu.MenuContent>) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
Creates a new button with given name that sets given content on click/press.
createContentControls() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentCredits() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentFeedback() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentGameplay() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentLoad() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createContentVideo() - Method in class com.almasb.fxgl.scene.FXGLMenu
 
createExtraMenu() - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createMenuBodyGameMenu() - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
createMenuBodyGameMenu() - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createMenuBodyMainMenu() - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
createMenuBodyMainMenu() - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createOptionsMenu() - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createProfileView(String) - Method in class com.almasb.fxgl.scene.FXGLMenu
Create view for profile name.
createProfileView(String) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
createProfileView(String) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createProfileView(String) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
 
createTitleView(String) - Method in class com.almasb.fxgl.scene.FXGLMenu
Create view for the app title.
createTitleView(String) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
createTitleView(String) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createTitleView(String) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
 
createVersionView(String) - Method in class com.almasb.fxgl.scene.FXGLMenu
Create view for version string.
createVersionView(String) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
createVersionView(String) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
createVersionView(String) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
 
credits - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
currentSceneProperty() - Method in interface com.almasb.fxgl.service.Display
 
currentValueProperty() - Method in class com.almasb.fxgl.ui.ProgressBar
 
customDialog(String, Node, Runnable, Button...) - Method in interface com.almasb.fxgl.service.DialogFactory
Deprecated.
customDialog(Node, Runnable) - Method in interface com.almasb.fxgl.service.DialogFactory
 

D

damage(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Damage component by given value.
damagePercentageCurrent(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Damage component by given percentage.
damagePercentageMax(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Damage component by given percentage.
delay(Duration) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
deleteProfileTask(String) - Static method in class com.almasb.fxgl.saving.SaveLoadManager
Delete profile.
deleteSaveFileTask(SaveFile) - Method in class com.almasb.fxgl.saving.SaveLoadManager
 
DeveloperMenuBarController - Class in com.almasb.fxgl.app
 
DeveloperMenuBarController() - Constructor for class com.almasb.fxgl.app.DeveloperMenuBarController
 
DIALOG_FACTORY - Static variable in interface com.almasb.fxgl.service.ServiceType
 
DialogFactory - Interface in com.almasb.fxgl.service
 
discolor() - Method in class com.almasb.fxgl.texture.Texture
Discoloring is done via setting each pixel to white but preserving opacity (alpha channel).
Display - Interface in com.almasb.fxgl.service
Display service.
DISPLAY - Static variable in interface com.almasb.fxgl.service.ServiceType
 
dispose() - Method in class com.almasb.fxgl.texture.AnimatedTexture
 
dispose() - Method in class com.almasb.fxgl.texture.Texture
 
distance(PositionComponent) - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
distance(GameEntity) - Method in class com.almasb.fxgl.entity.GameEntity
 
downloadTask(String) - Method in interface com.almasb.fxgl.service.Net
 
draw(GraphicsContext) - Method in class com.almasb.fxgl.entity.component.DrawableComponent
 
DrawableComponent - Class in com.almasb.fxgl.entity.component
Allows drawing directly to graphics context.
DrawableComponent(BiConsumer<GraphicsContext, Entity>) - Constructor for class com.almasb.fxgl.entity.component.DrawableComponent
 
duration(Duration) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
duration() - Method in interface com.almasb.fxgl.texture.AnimationChannel
 

E

EMPTY - Variable in class com.almasb.fxgl.scene.FXGLMenu
 
emptyChar() - Method in interface com.almasb.fxgl.entity.TextEntityFactory
 
enabledMenuItems - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
endContact(Contact) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
Entities - Class in com.almasb.fxgl.entity
Helper class with static convenience methods.
Entities.GameEntityBuilder - Class in com.almasb.fxgl.entity
Provides fluent API for building entities.
EntityEvent - Class in com.almasb.fxgl.entity
A general entity event.
EntityEvent(EventType<? extends Event>, Entity, Entity) - Constructor for class com.almasb.fxgl.entity.EntityEvent
Constructs entity event with given type, trigger entity and the entity being targeted by the event.
EntityEvent(EventType<? extends Event>, Entity) - Constructor for class com.almasb.fxgl.entity.EntityEvent
Constructs entity event with given type and trigger entity.
EntityFactory - Interface in com.almasb.fxgl.entity
Marks a class that is responsible for creating entities.
EntitySpawner - Interface in com.almasb.fxgl.entity
Spawns an entity given spawn data.
EntityView - Class in com.almasb.fxgl.entity
Represents the visual aspect of an entity.
EntityView() - Constructor for class com.almasb.fxgl.entity.EntityView
Constructs a view with no content.
EntityView(Node) - Constructor for class com.almasb.fxgl.entity.EntityView
Constructs a view with given graphics content.
EntityView(RenderLayer) - Constructor for class com.almasb.fxgl.entity.EntityView
Constructs a view with given render layer.
EntityView(Node, RenderLayer) - Constructor for class com.almasb.fxgl.entity.EntityView
Constructs a view with given graphics and render layer.
equals(Object) - Method in class com.almasb.fxgl.entity.component.IDComponent
 
equals(Object) - Method in class com.almasb.fxgl.input.UserAction
 
errorDialog(Throwable, Runnable) - Method in interface com.almasb.fxgl.service.DialogFactory
 
errorDialog(Throwable) - Method in interface com.almasb.fxgl.service.DialogFactory
 
errorDialog(String) - Method in interface com.almasb.fxgl.service.DialogFactory
 
errorDialog(String, Runnable) - Method in interface com.almasb.fxgl.service.DialogFactory
 
EVENT_BUS - Static variable in interface com.almasb.fxgl.service.ServiceType
 
EventBus - Interface in com.almasb.fxgl.service
Service for event dispatching, listening and handling.
EXCEPTION_HANDLER - Static variable in interface com.almasb.fxgl.service.ServiceType
 
ExceptionHandler - Interface in com.almasb.fxgl.service
A service for handling exceptions.
Executor - Interface in com.almasb.fxgl.service
Asynchronous executor service.
EXECUTOR - Static variable in interface com.almasb.fxgl.service.ServiceType
 
exit() - Method in class com.almasb.fxgl.app.GameApplication
Exit the application.
ExitListener - Interface in com.almasb.fxgl.app.listener
 
ExpireCleanControl - Class in com.almasb.fxgl.entity.control
Removes an entity from the world after a certain duration.
ExpireCleanControl(Duration) - Constructor for class com.almasb.fxgl.entity.control.ExpireCleanControl
The expire duration timer starts when the entity is attached to the world, so it does not start immediately when this control is created.

F

fadeIn(Node, Duration) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeIn(Node, Duration, Runnable) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeInOut(Node, Duration) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeInOut(Node, Duration, Runnable) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeOut(Node, Duration) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeOut(Node, Duration, Runnable) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeOutIn(Node, Duration) - Method in interface com.almasb.fxgl.service.UIFactory
 
fadeOutIn(Node, Duration, Runnable) - Method in interface com.almasb.fxgl.service.UIFactory
 
fireAction() - Method in class com.almasb.fxgl.input.UserAction
 
fireActionBegin() - Method in class com.almasb.fxgl.input.UserAction
 
fireActionEnd() - Method in class com.almasb.fxgl.input.UserAction
 
fireContinue() - Method in class com.almasb.fxgl.scene.FXGLMenu
Loads the game state from last modified save file.
fireDelete(SaveFile) - Method in class com.almasb.fxgl.scene.FXGLMenu
 
fireEvent(Event) - Method in interface com.almasb.fxgl.service.Input
Fire JavaFX event.
fireExit() - Method in class com.almasb.fxgl.scene.FXGLMenu
App will clean up the world/the scene and exit.
fireExitToMainMenu() - Method in class com.almasb.fxgl.scene.FXGLMenu
App will clean up the world/the scene and enter main menu.
fireLoad(SaveFile) - Method in class com.almasb.fxgl.scene.FXGLMenu
Loads the game state from previously saved file.
fireLogout() - Method in class com.almasb.fxgl.scene.FXGLMenu
Can only be fired from main menu.
fireMultiplayer() - Method in class com.almasb.fxgl.scene.FXGLMenu
Call multiplayer access in main menu.
fireNewGame() - Method in class com.almasb.fxgl.scene.FXGLMenu
Can only be fired from main menu.
fireResume() - Method in class com.almasb.fxgl.scene.FXGLMenu
Can only be fired from game menu.
fireSave() - Method in class com.almasb.fxgl.scene.FXGLMenu
Can only be fired from game menu.
frames() - Method in interface com.almasb.fxgl.texture.AnimationChannel
 
from(SpawnData) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
from(Object) - Static method in class com.almasb.fxgl.parser.KVFile
A factory constructor for KVFile, which also populates the created instance with key-value data from given object using its declared fields.
fullScreen - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
FXGLButton - Class in com.almasb.fxgl.ui
JavaFX Button styled with FXGL CSS.
FXGLButton() - Constructor for class com.almasb.fxgl.ui.FXGLButton
 
FXGLButton(String) - Constructor for class com.almasb.fxgl.ui.FXGLButton
 
FXGLChoiceBox<T> - Class in com.almasb.fxgl.ui
JavaFX ChoiceBox styled with FXGL CSS.
FXGLChoiceBox() - Constructor for class com.almasb.fxgl.ui.FXGLChoiceBox
 
FXGLChoiceBox(ObservableList<T>) - Constructor for class com.almasb.fxgl.ui.FXGLChoiceBox
 
FXGLDefaultMenu - Class in com.almasb.fxgl.scene.menu
This is the default FXGL menu used if the users don't provide their own.
FXGLDefaultMenu(GameApplication, MenuType) - Constructor for class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
FXGLMenu - Class in com.almasb.fxgl.scene
This is a base class for main/game menus.
FXGLMenu(GameApplication, MenuType) - Constructor for class com.almasb.fxgl.scene.FXGLMenu
 
FXGLMenu.MenuContent - Class in com.almasb.fxgl.scene
A generic vertical box container for menu content where each element is followed by a separator.
FXGLScene - Class in com.almasb.fxgl.scene
Base class for all FXGL scenes.
FXGLScene() - Constructor for class com.almasb.fxgl.scene.FXGLScene
 
FXGLSpinner<T> - Class in com.almasb.fxgl.ui
 
FXGLSpinner(ObservableList<T>) - Constructor for class com.almasb.fxgl.ui.FXGLSpinner
 

G

GameApplication - Class in com.almasb.fxgl.app
To use FXGL extend this class and implement necessary methods.
GameApplication() - Constructor for class com.almasb.fxgl.app.GameApplication
 
GameEntity - Class in com.almasb.fxgl.entity
Entity that guarantees to have Type, Position, Rotation, BoundingBox and View components.
GameEntity() - Constructor for class com.almasb.fxgl.entity.GameEntity
 
GameEntityBuilder() - Constructor for class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
GameScene - Class in com.almasb.fxgl.scene
Represents the scene that shows game objects on the screen during "play" mode.
GameScene(int, int) - Constructor for class com.almasb.fxgl.scene.GameScene
 
GameSettings - Class in com.almasb.fxgl.settings
Data structure for variables that are initialised before the application (game) starts.
GameSettings() - Constructor for class com.almasb.fxgl.settings.GameSettings
 
GameWorld - Class in com.almasb.fxgl.entity
Represents pure logical state of game.
GameWorld() - Constructor for class com.almasb.fxgl.entity.GameWorld
 
get(Class<T>) - Method in interface com.almasb.fxgl.service.Pooler
Either an existing "free" pooled instance is returned or a new instance will be created.
getAchievement() - Method in class com.almasb.fxgl.gameplay.AchievementEvent
 
getAchievementManager() - Method in class com.almasb.fxgl.app.GameApplication
 
getApp() - Method in class com.almasb.fxgl.app.ApplicationModule
 
getAppBounds() - Method in class com.almasb.fxgl.app.GameApplication
 
getAppHeight() - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
getApplicationMode() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getAssetLoader() - Method in class com.almasb.fxgl.app.GameApplication
 
getAsString() - Static method in class com.almasb.fxgl.util.Version
 
getAudioPlayer() - Method in class com.almasb.fxgl.app.GameApplication
 
getBackgroundColor() - Method in interface com.almasb.fxgl.service.NotificationService
 
getBBox(Entity) - Static method in class com.almasb.fxgl.entity.Entities
Convenient way to obtain bbox component.
getBindings() - Method in interface com.almasb.fxgl.service.Input
 
getBlendMode() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getBody() - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
getBottomY() - Method in class com.almasb.fxgl.entity.GameEntity
 
getBoundingBoxComponent() - Method in class com.almasb.fxgl.entity.GameEntity
 
getBounds() - Method in class com.almasb.fxgl.physics.HitBox
 
getBoxA() - Method in class com.almasb.fxgl.physics.CollisionResult
 
getBoxB() - Method in class com.almasb.fxgl.physics.CollisionResult
 
getBundle(String) - Method in class com.almasb.fxgl.saving.UserProfile
 
getCenter() - Method in class com.almasb.fxgl.entity.GameEntity
 
getCenterLocal() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getCenterWorld() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
If entity doesn't have PositionComponent then the center point is the same as local center.
getChildren() - Method in class com.almasb.fxgl.app.SubState
 
getClosestEntity(Entity, Predicate<Entity>) - Method in class com.almasb.fxgl.entity.GameWorld
Returns the closest entity to the given entity with given filter.
getCollidingEntities(Entity) - Method in class com.almasb.fxgl.entity.GameWorld
Returns a list of entities which colliding with given entity.
getCollidingEntities(Array<Entity>, Entity) - Method in class com.almasb.fxgl.entity.GameWorld
getColor() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getColor() - Method in class com.almasb.fxgl.effect.Vignette
 
getColor() - Method in class com.almasb.fxgl.physics.PhysicsParticleComponent
 
getConnection() - Method in interface com.almasb.fxgl.service.Net
 
getContentRoot() - Method in class com.almasb.fxgl.scene.FXGLScene
 
getCredits() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getCSSFileName() - Method in enum com.almasb.fxgl.scene.menu.MenuStyle
 
getCurrentChannel() - Method in class com.almasb.fxgl.texture.AnimatedTexture
 
getCurrentScene() - Method in interface com.almasb.fxgl.service.Display
 
getCurrentState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getCurrentValue() - Method in class com.almasb.fxgl.ui.ProgressBar
Gets the value of the property currentValue.
getCustomMenu() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
getDefinition() - Method in class com.almasb.fxgl.physics.PhysicsParticleComponent
 
getDialogState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getDirection() - Method in class com.almasb.fxgl.entity.control.ProjectileControl
 
getDisplay() - Method in class com.almasb.fxgl.app.GameApplication
 
getEffect() - Method in class com.almasb.fxgl.scene.FXGLScene
 
getEmitter() - Method in class com.almasb.fxgl.effect.ParticleControl
 
getEnabledMenuItems() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getEndColor() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getEntitiesAt(Point2D) - Method in class com.almasb.fxgl.entity.GameWorld
Returns a list of entities at given position.
getEntitiesAt(Array<Entity>, Point2D) - Method in class com.almasb.fxgl.entity.GameWorld
GC-friendly version of GameWorld.getEntitiesAt(Point2D).
getEntitiesByLayer(RenderLayer) - Method in class com.almasb.fxgl.entity.GameWorld
Returns a list of entities which have the given render layer index.
getEntitiesByLayer(Array<Entity>, RenderLayer) - Method in class com.almasb.fxgl.entity.GameWorld
getEntitiesByType(Enum<?>...) - Method in class com.almasb.fxgl.entity.GameWorld
This query only works on entities with TypeComponent.
getEntitiesByType(Array<Entity>, Enum<?>...) - Method in class com.almasb.fxgl.entity.GameWorld
GC-friendly version of GameWorld.getEntitiesByType(Enum[]).
getEntitiesFiltered(Predicate<Entity>) - Method in class com.almasb.fxgl.entity.GameWorld
Returns a list of entities which are filtered by given predicate.
getEntitiesFiltered(Array<Entity>, Predicate<Entity>) - Method in class com.almasb.fxgl.entity.GameWorld
getEntitiesInRange(Rectangle2D) - Method in class com.almasb.fxgl.entity.GameWorld
Returns a list of entities which are partially or entirely in the specified rectangular selection.
getEntitiesInRange(Array<Entity>, double, double, double, double) - Method in class com.almasb.fxgl.entity.GameWorld
getEntity() - Method in class com.almasb.fxgl.physics.RaycastResult
 
getEntityByID(String, int) - Method in class com.almasb.fxgl.entity.GameWorld
Returns an entity whose IDComponent matches given name and id.
getEntityFactory() - Method in class com.almasb.fxgl.entity.GameWorld
 
getEventBus() - Method in class com.almasb.fxgl.app.GameApplication
 
getExceptionHandler() - Method in class com.almasb.fxgl.app.GameApplication
 
getExecutor() - Method in class com.almasb.fxgl.app.GameApplication
 
getFullID() - Method in class com.almasb.fxgl.entity.component.IDComponent
 
getGameMenuState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getGameScene() - Method in class com.almasb.fxgl.app.GameApplication
 
getGameState() - Method in class com.almasb.fxgl.app.GameApplication
 
getGameWorld() - Method in class com.almasb.fxgl.app.GameApplication
 
getGlobalMusicVolume() - Method in interface com.almasb.fxgl.service.AudioPlayer
 
getGlobalSoundVolume() - Method in interface com.almasb.fxgl.service.AudioPlayer
 
getGraphicsContext() - Method in class com.almasb.fxgl.scene.GameScene
Returns graphics context of the game scene.
getGravityFunction() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getGridX(int) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Note: if there is no bbox attached, entity is considered as a point, else as a rectangle with the center placed in the cell.
getGridY(int) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Note: if there is no bbox attached, entity is considered as a point, else as a rectangle with the center placed in the cell.
getHeight() - Method in class com.almasb.fxgl.app.GameApplication
 
getHeight() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Returns total height of the bounding box, i.e.
getHeight() - Method in class com.almasb.fxgl.entity.GameEntity
 
getHeight() - Method in class com.almasb.fxgl.physics.HitBox
 
getHeight() - Method in class com.almasb.fxgl.scene.FXGLScene
 
getHeight() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getID() - Method in class com.almasb.fxgl.entity.component.IDComponent
 
getInput() - Method in class com.almasb.fxgl.app.GameApplication
 
getInput() - Method in class com.almasb.fxgl.app.State
 
getIntensity() - Method in class com.almasb.fxgl.effect.Vignette
 
getIntroState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getJBox2DWorld() - Method in class com.almasb.fxgl.physics.PhysicsWorld
Note: certain modifications to the jbox2d world directly may not be recognized by FXGL.
getLatestVersionTask() - Method in interface com.almasb.fxgl.service.Net
 
getLinearVelocity() - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
getLoadingState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getMainMenuState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getMasterTimer() - Method in class com.almasb.fxgl.app.GameApplication
 
getMax() - Method in class com.almasb.fxgl.gameplay.AchievementProgressEvent
 
getMaxValue() - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
 
getMaxX() - Method in class com.almasb.fxgl.physics.HitBox
 
getMaxXLocal() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Note: same as width, unless specified otherwise.
getMaxXWorld() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getMaxXWorld() - Method in class com.almasb.fxgl.physics.HitBox
 
getMaxY() - Method in class com.almasb.fxgl.physics.HitBox
 
getMaxYLocal() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Note: same as height, unless specified otherwise.
getMaxYWorld() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getMaxYWorld() - Method in class com.almasb.fxgl.physics.HitBox
 
getMenuKey() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getMenuListener() - Method in class com.almasb.fxgl.app.GameApplication
 
getMenuStyle() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getMinX() - Method in class com.almasb.fxgl.physics.HitBox
 
getMinXLocal() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getMinXWorld() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getMinXWorld() - Method in class com.almasb.fxgl.physics.HitBox
 
getMinY() - Method in class com.almasb.fxgl.physics.HitBox
 
getMinYLocal() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getMinYWorld() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
getMinYWorld() - Method in class com.almasb.fxgl.physics.HitBox
 
getMousePositionUI() - Method in interface com.almasb.fxgl.service.Input
 
getMousePositionWorld() - Method in interface com.almasb.fxgl.service.Input
 
getMouseXUI() - Method in interface com.almasb.fxgl.service.Input
 
getMouseXWorld() - Method in interface com.almasb.fxgl.service.Input
 
getMouseYUI() - Method in interface com.almasb.fxgl.service.Input
 
getMouseYWorld() - Method in interface com.almasb.fxgl.service.Input
 
getName() - Method in class com.almasb.fxgl.entity.component.IDComponent
 
getName() - Method in class com.almasb.fxgl.input.UserAction
 
getName() - Method in class com.almasb.fxgl.physics.HitBox
 
getNet() - Method in class com.almasb.fxgl.app.GameApplication
 
getNodes() - Method in class com.almasb.fxgl.entity.EntityView
Returns nodes attached to this view.
getNotification() - Method in class com.almasb.fxgl.gameplay.NotificationEvent
 
getNotificationService() - Method in class com.almasb.fxgl.app.GameApplication
 
getNumParticles() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getOsArchString() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
getOsVersionString() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
getPhysics(Entity) - Static method in class com.almasb.fxgl.entity.Entities
Convenient way to obtain physics component.
getPhysicsWorld() - Method in class com.almasb.fxgl.app.GameApplication
 
getPlayState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
getPoint() - Method in class com.almasb.fxgl.physics.RaycastResult
 
getPosition(Entity) - Static method in class com.almasb.fxgl.entity.Entities
Convenient way to obtain position component.
getPosition() - Method in class com.almasb.fxgl.entity.GameEntity
 
getPosition() - Method in interface com.almasb.fxgl.service.NotificationService
 
getPositionComponent() - Method in class com.almasb.fxgl.entity.GameEntity
 
getProfile() - Method in class com.almasb.fxgl.saving.LoadEvent
 
getProfile() - Method in class com.almasb.fxgl.saving.SaveEvent
 
getQTE() - Method in class com.almasb.fxgl.app.GameApplication
 
getQuestService() - Method in class com.almasb.fxgl.app.GameApplication
 
getRadius() - Method in class com.almasb.fxgl.effect.Vignette
 
getRandomSize() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getRenderLayer() - Method in class com.almasb.fxgl.entity.component.ViewComponent
 
getRenderLayer() - Method in class com.almasb.fxgl.entity.EntityView
 
getRenderLayer() - Method in class com.almasb.fxgl.entity.GameEntity
 
getRightX() - Method in class com.almasb.fxgl.entity.GameEntity
 
getRoot() - Method in class com.almasb.fxgl.scene.FXGLScene
 
getRotation(Entity) - Static method in class com.almasb.fxgl.entity.Entities
Convenient way to obtain rotation component.
getRotation() - Method in class com.almasb.fxgl.entity.GameEntity
 
getRotationComponent() - Method in class com.almasb.fxgl.entity.GameEntity
 
getSaveLoadManager() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
getScaleRatio() - Method in interface com.almasb.fxgl.service.Display
 
getSceneDimensions() - Method in interface com.almasb.fxgl.service.Display
 
getSelectedEntity() - Method in class com.almasb.fxgl.entity.GameWorld
Returns last selected (clicked on by mouse) entity.
getServices() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getSettings() - Method in class com.almasb.fxgl.app.GameApplication
 
getShape() - Method in class com.almasb.fxgl.physics.HitBox
 
getSizeMax() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getSizeMin() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getSpeed() - Method in class com.almasb.fxgl.entity.control.ProjectileControl
 
getStartColor() - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
getStateMachine() - Method in class com.almasb.fxgl.app.GameApplication
 
getStream(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Opens a stream to resource with given name.
getTargetEntity() - Method in class com.almasb.fxgl.entity.EntityEvent
Returns entity that was target of the event.
getTick() - Method in class com.almasb.fxgl.app.GameApplication
 
getTimer() - Method in class com.almasb.fxgl.app.State
 
getTitle() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getTriggerEntity() - Method in class com.almasb.fxgl.entity.EntityEvent
 
getType(Entity) - Static method in class com.almasb.fxgl.entity.Entities
Convenient way to obtain type component.
getType() - Method in class com.almasb.fxgl.entity.GameEntity
 
getTypeComponent() - Method in class com.almasb.fxgl.entity.GameEntity
 
getUIFactory() - Method in class com.almasb.fxgl.app.GameApplication
 
getUINodes() - Method in class com.almasb.fxgl.scene.GameScene
 
getValue() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
getValue() - Method in class com.almasb.fxgl.gameplay.AchievementProgressEvent
 
getVectorFromMouse(Point2D) - Method in interface com.almasb.fxgl.service.Input
 
getVectorToMouse(Point2D) - Method in interface com.almasb.fxgl.service.Input
 
getVelocity() - Method in class com.almasb.fxgl.entity.control.ProjectileControl
 
getVelocityX() - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
getVelocityY() - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
getVersion() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getView() - Method in class com.almasb.fxgl.app.SubState
 
getView() - Method in class com.almasb.fxgl.entity.component.ViewComponent
 
getView(Entity) - Static method in class com.almasb.fxgl.entity.Entities
Convenient way to obtain main view component.
getView() - Method in class com.almasb.fxgl.entity.GameEntity
 
getViewComponent() - Method in class com.almasb.fxgl.entity.GameEntity
 
getViewport() - Method in class com.almasb.fxgl.scene.FXGLScene
 
getWidth() - Method in class com.almasb.fxgl.app.GameApplication
 
getWidth() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Returns total width of the bounding box, i.e.
getWidth() - Method in class com.almasb.fxgl.entity.GameEntity
 
getWidth() - Method in class com.almasb.fxgl.physics.HitBox
 
getWidth() - Method in class com.almasb.fxgl.scene.FXGLScene
 
getWidth() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
getX() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
getX() - Method in class com.almasb.fxgl.entity.GameEntity
 
getY() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
getY() - Method in class com.almasb.fxgl.entity.GameEntity
 
globalMusicVolumeProperty() - Method in interface com.almasb.fxgl.service.AudioPlayer
 
globalSoundVolumeProperty() - Method in interface com.almasb.fxgl.service.AudioPlayer
 
GTAVMenu - Class in com.almasb.fxgl.scene.menu
 
GTAVMenu(GameApplication, MenuType) - Constructor for class com.almasb.fxgl.scene.menu.GTAVMenu
 

H

handle(Throwable) - Method in interface com.almasb.fxgl.service.ExceptionHandler
Handles given checked exception.
handleFatal(Throwable) - Method in interface com.almasb.fxgl.service.ExceptionHandler
Handles unchecked fatal exception.
Handles - Annotation Type in com.almasb.fxgl.annotation
Indicates that a method handles an event of specific type.
hasCollided() - Method in class com.almasb.fxgl.physics.CollisionResult
 
hashCode() - Method in class com.almasb.fxgl.entity.component.IDComponent
 
hashCode() - Method in class com.almasb.fxgl.input.UserAction
 
hasSavesProperty() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
HealthComponent - Class in com.almasb.fxgl.entity.component
Represents some form of entity health based on integer values.
HealthComponent(int) - Constructor for class com.almasb.fxgl.entity.component.HealthComponent
 
height - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
heightProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
HitBox - Class in com.almasb.fxgl.physics
A bounding collision box.
HitBox(String, BoundingShape) - Constructor for class com.almasb.fxgl.physics.HitBox
Creates a hit box with given name and shape.
HitBox(String, Point2D, BoundingShape) - Constructor for class com.almasb.fxgl.physics.HitBox
Creates a hit box with given name, local origin (top-left) and shape.
hitBoxesProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
hostMultiplayerTask() - Method in interface com.almasb.fxgl.service.Net
 

I

IDComponent - Class in com.almasb.fxgl.entity.component
Adds ID to an entity, so it can be uniquely identified.
IDComponent(String, int) - Constructor for class com.almasb.fxgl.entity.component.IDComponent
Constructs ID component with given entity name and id.
index() - Method in interface com.almasb.fxgl.entity.RenderLayer
Returns index value for this layer.
InGameWindow - Class in com.almasb.fxgl.ui
Represents an in-game window as part of game UI.
InGameWindow(String) - Constructor for class com.almasb.fxgl.ui.InGameWindow
Constructs an in-game window with minimize and close icons.
InGameWindow(String, InGameWindow.WindowDecor) - Constructor for class com.almasb.fxgl.ui.InGameWindow
Constructs an in-game window with given window decor.
InGameWindow.WindowDecor - Enum in com.almasb.fxgl.ui
 
init() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
init() - Method in class com.almasb.fxgl.app.GameApplication
 
init(Image, Point2D, Point2D, Point2D, double, Point2D, Duration, Paint, Paint, BlendMode) - Method in class com.almasb.fxgl.effect.Particle
 
init(HitBox, HitBox) - Method in class com.almasb.fxgl.physics.CollisionResult
Init CollisionResult with positive result, i.e.
initAchievements() - Method in class com.almasb.fxgl.app.GameApplication
Override to register your achievements.
initAndShow() - Method in interface com.almasb.fxgl.service.Display
Must be called on FX thread.
initAssets() - Method in class com.almasb.fxgl.app.GameApplication
Initialize game assets, such as Texture, Sound, Music, etc.
initGame() - Method in class com.almasb.fxgl.app.GameApplication
Initialize game objects.
initGameVars(Map<String, Object>) - Method in class com.almasb.fxgl.app.GameApplication
Can be overridden to provide global variables.
initInput() - Method in class com.almasb.fxgl.app.GameApplication
Initialize input, i.e.
initPhysics() - Method in class com.almasb.fxgl.app.GameApplication
Initialize collision handlers, physics properties.
initSettings(GameSettings) - Method in class com.almasb.fxgl.app.GameApplication
Initialize app settings.
initUI() - Method in class com.almasb.fxgl.app.GameApplication
Initialize UI objects.
Input - Interface in com.almasb.fxgl.service
Allows input data queries as well as action bindings.
inputDialog(String, Consumer<String>) - Method in interface com.almasb.fxgl.service.DialogFactory
 
inputDialog(String, Predicate<String>, Consumer<String>) - Method in interface com.almasb.fxgl.service.DialogFactory
 
inputDialogWithCancel(String, Predicate<String>, Consumer<String>) - Method in interface com.almasb.fxgl.service.DialogFactory
 
introEnabled - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
isCircle() - Method in class com.almasb.fxgl.physics.BoundingShape
 
isCloseConfirmation() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
isColliding(GameEntity) - Method in class com.almasb.fxgl.entity.GameEntity
 
isColliding(HitBox, HitBox, double, double) - Static method in class com.almasb.fxgl.physics.SAT
Note: NOT thread-safe but GC-friendly.
isCollidingWith(BoundingBoxComponent) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
isCompatible(String, String) - Method in class com.almasb.fxgl.saving.UserProfile
 
isFullScreen() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
isHeld(KeyCode) - Method in interface com.almasb.fxgl.service.Input
 
isHeld(MouseButton) - Method in interface com.almasb.fxgl.service.Input
 
isInGameMenu() - Method in class com.almasb.fxgl.app.AppStateMachine
 
isInPlay() - Method in class com.almasb.fxgl.app.AppStateMachine
 
isIntroEnabled() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
isLabelVisible() - Method in class com.almasb.fxgl.ui.ProgressBar
 
isLinux() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
isMac() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
isMenuEnabled() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
isOutside(Rectangle2D) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
isOutside(double, double, double, double) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
isProcessInput() - Method in interface com.almasb.fxgl.service.Input
 
isProfilingEnabled() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
isRaycastIgnored() - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
isRectangle() - Method in class com.almasb.fxgl.physics.BoundingShape
 
isRegisterInput() - Method in interface com.almasb.fxgl.service.Input
 
isSnapToScreen() - Method in class com.almasb.fxgl.ui.InGameWindow
 
isSnapToWindows() - Method in class com.almasb.fxgl.ui.InGameWindow
 
isSolaris() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
isSwitchedOn() - Method in class com.almasb.fxgl.ui.ToggleSwitch
 
isType(Object) - Method in class com.almasb.fxgl.entity.component.TypeComponent
Example: entity.getTypeComponent().isType(Type.PLAYER);
isType(Object) - Method in class com.almasb.fxgl.entity.GameEntity
Example: entity.isType(Type.PLAYER);
isUnix() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
isWindows() - Static method in class com.almasb.fxgl.util.PlatformUtils
 
isWithin(Rectangle2D) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
isWithin(double, double, double, double) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
isWithin(Rectangle2D) - Method in class com.almasb.fxgl.entity.GameEntity
 
isZero() - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Check if value is 0.

J

JavaScriptParser - Class in com.almasb.fxgl.parser
Allows to parse valid javascript source files.
JavaScriptParser(String) - Constructor for class com.almasb.fxgl.parser.JavaScriptParser
Constructs new javascript parser for given .js file or source string.
JSControl - Class in com.almasb.fxgl.entity.control
Control that runs scripted entity behavior from a javascript file.
JSControl(String) - Constructor for class com.almasb.fxgl.entity.control.JSControl
Constructs new instance with given source, either string or filename.

K

KeepOnScreenControl - Class in com.almasb.fxgl.entity.control
A control that keeps an entity within the viewport.
KeepOnScreenControl(boolean, boolean) - Constructor for class com.almasb.fxgl.entity.control.KeepOnScreenControl
 
KVFile - Class in com.almasb.fxgl.parser
Represents a simple key value file, similar to Properties.
KVFile(List<String>) - Constructor for class com.almasb.fxgl.parser.KVFile
Constructs KVFile from lines of plain text.

L

LiftControl - Class in com.almasb.fxgl.entity.control
Lift control.
LiftControl(Duration, double, boolean) - Constructor for class com.almasb.fxgl.entity.control.LiftControl
Constructs lift control (moving vertically).
listener - Variable in class com.almasb.fxgl.scene.FXGLMenu
 
load(UserProfile) - Method in interface com.almasb.fxgl.saving.UserProfileSavable
Called during profile load.
LOAD_PROFILE - Static variable in class com.almasb.fxgl.saving.LoadEvent
Fired when profile is being loaded.
loadAppIcon(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads an app icon from /assets/ui/icons/.
loadBehaviorTree(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads a behavior tree from /assets/ai/.
loadCSS(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads a CSS file from /assets/ui/css/.
loadCursorImage(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads cursor image with given name from /assets/ui/cursors/.
LoadEvent - Class in com.almasb.fxgl.saving
Event related to any type of loading.
LoadEvent(EventType<LoadEvent>, UserProfile) - Constructor for class com.almasb.fxgl.saving.LoadEvent
 
loadFileNames(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads file names from a directory.
loadFont(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads a native JavaFX font with given name from /assets/ui/fonts/ wrapped in a FontFactory, which later can be used to produce fonts with different sizes without accessing the font file.
loadJSON(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads JSON file with given name from /assets/json/.
loadJSON(String, Class<T>) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads JSON file with given name from /assets/json/ and parses into an object of type T.
loadKV(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads KVFile with given name from /assets/kv/.
loadLastModifiedSaveFileTask() - Method in class com.almasb.fxgl.saving.SaveLoadManager
Loads last modified save file from saves directory.
loadMusic(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads sound with given name from /assets/music/.
loadProfileNamesTask() - Static method in class com.almasb.fxgl.saving.SaveLoadManager
Load all profile names.
loadProfileTask() - Method in class com.almasb.fxgl.saving.SaveLoadManager
Loads user profile from "profiles/".
loadResourceBundle(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads resource bundle with given name from "/assets/properties/".
loadSaveFilesTask() - Method in class com.almasb.fxgl.saving.SaveLoadManager
Loads save files with save file extension from SAVE_DIR.
loadScript(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads script with given name from /assets/scripts/ as a single string.
loadSound(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads sound with given name from /assets/sounds/.
loadState(DataFile) - Method in class com.almasb.fxgl.app.GameApplication
Called when MenuEvent.LOAD occurs.
loadTask(SaveFile) - Method in class com.almasb.fxgl.saving.SaveLoadManager
Load serializable data from external file on disk file system from saves directory which is in the directory where the game is start from.
loadText(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads text file with given name from /assets/text/ into List where each element represents a line in the file.
loadTexture(String) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads texture with given name from /assets/textures/.
loadTexture(String, double, double) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads texture with given name from /assets/textures/.
loadUI(String, UIController) - Method in interface com.almasb.fxgl.service.AssetLoader
Loads an FXML (.fxml) file from /assets/ui/.
log - Static variable in class com.almasb.fxgl.entity.EntityView
 
log(Logger) - Method in class com.almasb.fxgl.saving.UserProfile
 
log - Static variable in class com.almasb.fxgl.scene.FXGLMenu
The logger.

M

makeHPBar() - Static method in class com.almasb.fxgl.ui.ProgressBar
 
makeScreenBounds(double) - Static method in class com.almasb.fxgl.entity.Entities
Create an entity with bounding box around the screen with given thickness.
makeSkillBar() - Static method in class com.almasb.fxgl.ui.ProgressBar
 
maxValueProperty() - Method in class com.almasb.fxgl.ui.ProgressBar
 
maxXWorldProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
maxYWorldProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
MenuContent(Node...) - Constructor for class com.almasb.fxgl.scene.FXGLMenu.MenuContent
 
menuEnabled - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
MenuEventListener - Interface in com.almasb.fxgl.scene.menu
Listener for events that occur within menus.
MenuItem - Enum in com.almasb.fxgl.settings
 
menuKey - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
menuRoot - Variable in class com.almasb.fxgl.scene.FXGLMenu
 
MenuStyle - Enum in com.almasb.fxgl.scene.menu
FXGL built-in menu styles.
menuStyle - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
messageDialog(String, Runnable) - Method in interface com.almasb.fxgl.service.DialogFactory
 
messageDialog(String) - Method in interface com.almasb.fxgl.service.DialogFactory
 
minValueProperty() - Method in class com.almasb.fxgl.ui.ProgressBar
 
minXLocalProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
minXWorldProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
minYLocalProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
minYWorldProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
mockButtonPress(MouseButton) - Method in interface com.almasb.fxgl.service.Input
Mocks button press event.
mockButtonPress(MouseButton, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Mocks button press event.
mockButtonPress(MouseButton, double, double) - Method in interface com.almasb.fxgl.service.Input
Mocks button press event.
mockButtonPress(MouseButton, double, double, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Mocks button press event.
mockButtonRelease(MouseButton) - Method in interface com.almasb.fxgl.service.Input
Mocks button release event.
mockButtonRelease(MouseButton, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Mocks button release event.
mockButtonRelease(MouseButton, double, double) - Method in interface com.almasb.fxgl.service.Input
Mocks button release event.
mockButtonRelease(MouseButton, double, double, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Mocks button release event.
mockKeyPress(KeyCode) - Method in interface com.almasb.fxgl.service.Input
Mocks key press event.
mockKeyPress(KeyCode, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Mocks key press event.
mockKeyRelease(KeyCode) - Method in interface com.almasb.fxgl.service.Input
Mocks key release event.
mockKeyRelease(KeyCode, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Mocks key release event.
multiplyColor(Color) - Method in class com.almasb.fxgl.texture.Texture
Multiplies this texture's pixel color with given color.

N

name() - Method in interface com.almasb.fxgl.entity.RenderLayer
Returns a human readable name for this layer.
name() - Method in interface com.almasb.fxgl.texture.AnimationChannel
 
Net - Interface in com.almasb.fxgl.service
Defines methods for Net service.
NET - Static variable in interface com.almasb.fxgl.service.ServiceType
 
newButton(String) - Method in interface com.almasb.fxgl.service.UIFactory
 
newCheckBox() - Method in interface com.almasb.fxgl.service.UIFactory
 
newChoiceBox(ObservableList<T>) - Method in interface com.almasb.fxgl.service.UIFactory
 
newChoiceBox() - Method in interface com.almasb.fxgl.service.UIFactory
 
newExplosionEmitter() - Static method in class com.almasb.fxgl.effect.ParticleEmitters
 
newFireEmitter() - Static method in class com.almasb.fxgl.effect.ParticleEmitters
 
newFont(double) - Method in interface com.almasb.fxgl.service.UIFactory
 
newImplosionEmitter() - Static method in class com.almasb.fxgl.effect.ParticleEmitters
 
newRainEmitter(int) - Static method in class com.almasb.fxgl.effect.ParticleEmitters
 
newSmokeEmitter() - Static method in class com.almasb.fxgl.effect.ParticleEmitters
 
newSparkEmitter() - Static method in class com.almasb.fxgl.effect.ParticleEmitters
 
newSpinner(ObservableList<T>) - Method in interface com.almasb.fxgl.service.UIFactory
 
newText(String) - Method in interface com.almasb.fxgl.service.UIFactory
 
newText(String, double) - Method in interface com.almasb.fxgl.service.UIFactory
 
newText(String, Color, double) - Method in interface com.almasb.fxgl.service.UIFactory
 
NO_COLLISION - Static variable in class com.almasb.fxgl.physics.CollisionResult
Constant for reporting no collision.
NONE - Static variable in class com.almasb.fxgl.physics.RaycastResult
 
NOTIFICATION_SERVICE - Static variable in interface com.almasb.fxgl.service.ServiceType
 
NotificationEvent - Class in com.almasb.fxgl.gameplay
This event occurs when a notification has been shown to user.
NotificationEvent(Notification) - Constructor for class com.almasb.fxgl.gameplay.NotificationEvent
 
NotificationListener - Interface in com.almasb.fxgl.gameplay
Marks a service that wants to listen for notification events.
NotificationService - Interface in com.almasb.fxgl.service
Notification service allows to push notifications.

O

OffscreenCleanControl - Class in com.almasb.fxgl.entity.control
Control that removes an entity if it is outside of the visible area of the viewport.
OffscreenCleanControl() - Constructor for class com.almasb.fxgl.entity.control.OffscreenCleanControl
 
onAchievementEvent(AchievementEvent) - Method in interface com.almasb.fxgl.gameplay.AchievementListener
Fired on achievement event.
onAchievementEvent(AchievementEvent) - Method in interface com.almasb.fxgl.service.NotificationService
 
onAction() - Method in class com.almasb.fxgl.input.UserAction
Called as long as the trigger is being held (pressed).
onActionBegin() - Method in class com.almasb.fxgl.input.UserAction
Called once in the same tick when triggered.
onActionEnd() - Method in class com.almasb.fxgl.input.UserAction
Called once in the same tick when trigger was released.
onAdded(Entity) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.component.SelectableComponent
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.component.ViewComponent
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.control.CircularMovementControl
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.control.ExpireCleanControl
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.control.KeepOnScreenControl
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.control.LiftControl
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.control.OffscreenCleanControl
 
onAdded(Entity) - Method in class com.almasb.fxgl.entity.control.ProjectileControl
 
onAdded(Entity) - Method in class com.almasb.fxgl.physics.PhysicsControl
 
onCollision(Entity, Entity) - Method in class com.almasb.fxgl.physics.CollisionHandler
Called if entities A and B are currently colliding.
onCollisionBegin(Entity, Entity) - Method in class com.almasb.fxgl.physics.CollisionHandler
Called when entities A and B have just collided and weren't colliding in the last tick.
onCollisionEnd(Entity, Entity) - Method in class com.almasb.fxgl.physics.CollisionHandler
Called when entities A and B have just stopped colliding and were colliding in the last tick.
onComponentAdded(Component) - Method in class com.almasb.fxgl.scene.GameScene
 
onComponentRemoved(Component) - Method in class com.almasb.fxgl.scene.GameScene
 
onContinue() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onControlAdded(Control) - Method in class com.almasb.fxgl.scene.GameScene
 
onControlRemoved(Control) - Method in class com.almasb.fxgl.scene.GameScene
 
onDelete(SaveFile) - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onEnter(State) - Method in interface com.almasb.fxgl.app.listener.StateListener
 
onEnter(State) - Method in class com.almasb.fxgl.app.State
 
onEntityAdded(Entity) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
onEntityAdded(Entity) - Method in class com.almasb.fxgl.scene.GameScene
 
onEntityRemoved(Entity) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
onEntityRemoved(Entity) - Method in class com.almasb.fxgl.scene.GameScene
 
onExit() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
onExit() - Method in interface com.almasb.fxgl.app.listener.ExitListener
Called just before FXGL application exits.
onExit() - Method in interface com.almasb.fxgl.app.listener.StateListener
 
onExit() - Method in class com.almasb.fxgl.app.State
 
onExit() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onExitToMainMenu() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onHitBoxTrigger(Entity, Entity, HitBox, HitBox) - Method in class com.almasb.fxgl.physics.CollisionHandler
Called once per collision during the same tick when collision occurred.
onKeyEvent(KeyEvent) - Method in interface com.almasb.fxgl.service.Input
Called on key event.
onLoad(SaveFile) - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onLogout() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onMouseEvent(MouseEvent, Viewport, double) - Method in interface com.almasb.fxgl.service.Input
Called on mouse event.
onMultiplayer() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onNewGame() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onNotificationEvent(NotificationEvent) - Method in interface com.almasb.fxgl.gameplay.NotificationListener
Fired on notification event.
onNotificationEvent(NotificationEvent) - Method in interface com.almasb.fxgl.service.AudioPlayer
 
onPause() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
onPausedUpdate(double) - Method in class com.almasb.fxgl.app.GameApplication
Called every frame in any non-Play state.
onPostUpdate(double) - Method in class com.almasb.fxgl.app.GameApplication
Called after main loop tick has been completed in Play state.
onRemoved(Entity) - Method in class com.almasb.fxgl.effect.ParticleControl
 
onRemoved(Entity) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
onRemoved(Entity) - Method in class com.almasb.fxgl.entity.component.SelectableComponent
 
onRemoved(Entity) - Method in class com.almasb.fxgl.entity.component.ViewComponent
 
onResume() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
onResume() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onSave() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
onShowBBox(ActionEvent) - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
onTrackClicks(ActionEvent) - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
onUpdate(double) - Method in class com.almasb.fxgl.app.GameApplication
Called every frame _only_ in Play state.
onUpdate(double) - Method in interface com.almasb.fxgl.app.listener.StateListener
 
onUpdate(double) - Method in interface com.almasb.fxgl.app.listener.UpdateListener
 
onUpdate(double) - Method in class com.almasb.fxgl.app.State
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.effect.ParticleControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.CircularMovementControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.ExpireCleanControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.JSControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.KeepOnScreenControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.LiftControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.OffscreenCleanControl
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.entity.control.ProjectileControl
 
onUpdate(double) - Method in class com.almasb.fxgl.entity.GameWorld
 
onUpdate(Entity, double) - Method in class com.almasb.fxgl.physics.PhysicsControl
 
onUpdate(double) - Method in interface com.almasb.fxgl.service.Input
 
onUpdate(double) - Method in class com.almasb.fxgl.texture.AnimatedTexture
 
OnUserAction - Annotation Type in com.almasb.fxgl.annotation
Indicates that a method is called when user triggers an action.
onWorldReset() - Method in class com.almasb.fxgl.physics.PhysicsWorld
Resets physics world.
onWorldReset() - Method in class com.almasb.fxgl.scene.GameScene
 
onWorldUpdate(double) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
onWorldUpdate(double) - Method in class com.almasb.fxgl.scene.GameScene
 
openAddDialog() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
openBrowserTask(String) - Method in interface com.almasb.fxgl.service.Net
 
openColorAdjustDialog() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
openConsole() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
openEditDialog() - Method in class com.almasb.fxgl.app.DeveloperMenuBarController
 
openStreamTask(String) - Method in interface com.almasb.fxgl.service.Net
Note: the caller is responsible for closing the stream.

P

Particle - Class in com.almasb.fxgl.effect
Simple particle represented by a Shape or an Image.
Particle(Point2D, Point2D, Point2D, double, Point2D, Duration, Paint, Paint, BlendMode) - Constructor for class com.almasb.fxgl.effect.Particle
 
Particle(Image, Point2D, Point2D, Point2D, double, Point2D, Duration, Paint, Paint, BlendMode) - Constructor for class com.almasb.fxgl.effect.Particle
 
Particle() - Constructor for class com.almasb.fxgl.effect.Particle
 
ParticleControl - Class in com.almasb.fxgl.effect
 
ParticleControl(ParticleEmitter) - Constructor for class com.almasb.fxgl.effect.ParticleControl
Constructs particle control with specified emitter.
ParticleControl() - Constructor for class com.almasb.fxgl.effect.ParticleControl
 
ParticleEmitter - Class in com.almasb.fxgl.effect
A general particle emitter.
ParticleEmitter() - Constructor for class com.almasb.fxgl.effect.ParticleEmitter
 
ParticleEmitters - Class in com.almasb.fxgl.effect
Holds configuration of predefined particle emitters.
ParticleEmitters() - Constructor for class com.almasb.fxgl.effect.ParticleEmitters
 
particles - Variable in class com.almasb.fxgl.effect.ParticleControl
 
pauseAllMusic() - Method in interface com.almasb.fxgl.service.AudioPlayer
Pauses all currently playing music.
pauseMusic(Music) - Method in interface com.almasb.fxgl.service.AudioPlayer
Pauses given music if it was previously started with AudioPlayer.playSound(Sound).
PhysicsComponent - Class in com.almasb.fxgl.physics
Adds physics properties to an entity.
PhysicsComponent() - Constructor for class com.almasb.fxgl.physics.PhysicsComponent
 
PhysicsControl - Class in com.almasb.fxgl.physics
This control updates position and rotation components of entities based on the physics properties.
PhysicsParticleComponent - Class in com.almasb.fxgl.physics
Adds physics particle properties to an entity.
PhysicsParticleComponent() - Constructor for class com.almasb.fxgl.physics.PhysicsParticleComponent
 
PhysicsWorld - Class in com.almasb.fxgl.physics
Manages physics entities, collision handling and performs the physics tick.
PhysicsWorld(int, double) - Constructor for class com.almasb.fxgl.physics.PhysicsWorld
 
PlatformUtils - Class in com.almasb.fxgl.util
Provides information about platform specifics.
playMusic(String) - Method in interface com.almasb.fxgl.service.AudioPlayer
Convenience method to play the music given its filename.
playMusic(Music) - Method in interface com.almasb.fxgl.service.AudioPlayer
Plays given music based on its properties.
playSound(String) - Method in interface com.almasb.fxgl.service.AudioPlayer
Convenience method to play the sound given its filename.
playSound(Sound) - Method in interface com.almasb.fxgl.service.AudioPlayer
Plays given sound based on its properties.
Pooler - Interface in com.almasb.fxgl.service
Pooler service.
POOLER - Static variable in interface com.almasb.fxgl.service.ServiceType
 
popState() - Method in class com.almasb.fxgl.app.AppStateMachine
 
Position - Enum in com.almasb.fxgl.ui
Represents a 4 directional position of UI element(-s).
PositionComponent - Class in com.almasb.fxgl.entity.component
Component that adds a 2d position to an entity.
PositionComponent(double, double) - Constructor for class com.almasb.fxgl.entity.component.PositionComponent
Constructs a position component from given x and y.
PositionComponent(Point2D) - Constructor for class com.almasb.fxgl.entity.component.PositionComponent
Constructs a position component from given point.
PositionComponent() - Constructor for class com.almasb.fxgl.entity.component.PositionComponent
Constructs a position component with x = y = 0.
postSolve(Contact, ContactImpulse) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
preInit() - Method in class com.almasb.fxgl.app.GameApplication
This is called after core services are initialized but before any game init.
preSolve(Contact, Manifold) - Method in class com.almasb.fxgl.physics.PhysicsWorld
 
print() - Static method in class com.almasb.fxgl.util.Version
 
profileNameProperty() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
profilingEnabled - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
PROGRESS - Static variable in class com.almasb.fxgl.gameplay.AchievementProgressEvent
 
ProgressBar - Class in com.almasb.fxgl.ui
A generic progress bar.
ProgressBar() - Constructor for class com.almasb.fxgl.ui.ProgressBar
 
ProgressBar(boolean) - Constructor for class com.almasb.fxgl.ui.ProgressBar
 
progressDialog(DoubleProperty, Runnable) - Method in interface com.almasb.fxgl.service.DialogFactory
 
progressDialogIndeterminate(String, Runnable) - Method in interface com.almasb.fxgl.service.DialogFactory
 
ProjectileControl - Class in com.almasb.fxgl.entity.control
Generic projectile control.
ProjectileControl(Point2D, double) - Constructor for class com.almasb.fxgl.entity.control.ProjectileControl
 
pushNotification(String) - Method in interface com.almasb.fxgl.service.NotificationService
Push a notification with given message.
pushState(SubState) - Method in class com.almasb.fxgl.app.AppStateMachine
 
put(Object) - Method in interface com.almasb.fxgl.service.Pooler
Put the given object back to pool so it can reused.
putBundle(Bundle) - Method in class com.almasb.fxgl.saving.UserProfile
Stores a bundle in the user profile.

Q

QTE - Interface in com.almasb.fxgl.service
Service for using quick time events.
QTE - Static variable in interface com.almasb.fxgl.service.ServiceType
 
querySaveFiles() - Method in class com.almasb.fxgl.saving.SaveLoadManager
Asynchronously (with a progress dialog) loads save files into observable list SaveLoadManager.saveFiles().
QUEST_MANAGER - Static variable in interface com.almasb.fxgl.service.ServiceType
 
QuestService - Interface in com.almasb.fxgl.service
 
questsProperty() - Method in interface com.almasb.fxgl.service.QuestService
 

R

rand() - Method in class com.almasb.fxgl.effect.ParticleEmitter
Returns a value in [0..1).
rand(double, double) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Returns a value in [min..max).
range(double, double) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Forms a rectangle around the entity by extending min and max bounds with width in X and with height in Y directions.
raycast(Point2D, Point2D) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Performs a ray cast from start point to end point.
RaycastResult - Class in com.almasb.fxgl.physics
Result of a raycast.
read(Bundle) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
read(Bundle) - Method in class com.almasb.fxgl.entity.component.IDComponent
 
read(Bundle) - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
read(Bundle) - Method in class com.almasb.fxgl.entity.component.TypeComponent
 
ReadOnlyGameSettings - Class in com.almasb.fxgl.settings
A copy of GameSettings with public getters only.
rebind(UserAction, KeyCode) - Method in interface com.almasb.fxgl.service.Input
Rebinds an existing action to given key.
rebind(UserAction, KeyCode, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Rebinds an existing action to given key.
rebind(UserAction, MouseButton) - Method in interface com.almasb.fxgl.service.Input
Rebinds an action to given mouse button.
rebind(UserAction, MouseButton, InputModifier) - Method in interface com.almasb.fxgl.service.Input
Rebinds an action to given mouse button.
RechargeableComponent - Class in com.almasb.fxgl.entity.component
Any rechargeable component, such as HP, SP, ammo, etc.
RechargeableComponent(double) - Constructor for class com.almasb.fxgl.entity.component.RechargeableComponent
 
registerPool(Class<T>, Pool<T>) - Method in interface com.almasb.fxgl.service.Pooler
Make the pooler use the given pool for given type.
registerScene(FXGLScene) - Method in interface com.almasb.fxgl.service.Display
Register an FXGL scene to be managed by display settings.
relocateX(double) - Method in class com.almasb.fxgl.ui.InGameWindow
 
relocateY(double) - Method in class com.almasb.fxgl.ui.InGameWindow
 
removeCollisionHandler(CollisionHandler) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Removes a collision handler
removeEventHandler(EventType<T>, EventHandler<? super T>) - Method in interface com.almasb.fxgl.service.Input
Remove JavaFX event handler.
removeEventTrigger(<any>) - Method in class com.almasb.fxgl.entity.GameWorld
Remove event trigger from the world.
removeExitListener(ExitListener) - Method in class com.almasb.fxgl.app.GameApplication
 
removeGameView(EntityView) - Method in class com.almasb.fxgl.scene.GameScene
Remove a view from the game root.
removeHitBox(String) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
Removes a hit box with given name from the list of hit boxes for this entity.
removeNode(Node) - Method in class com.almasb.fxgl.entity.EntityView
Removes a child node attached to this view.
removePlayStateListener(StateListener) - Method in class com.almasb.fxgl.app.GameApplication
 
removeQuest(Quest) - Method in interface com.almasb.fxgl.service.QuestService
Remove the quest from service.
removeStateListener(StateListener) - Method in class com.almasb.fxgl.app.State
 
removeUI(UI) - Method in class com.almasb.fxgl.scene.GameScene
 
removeUINode(Node) - Method in class com.almasb.fxgl.scene.GameScene
Remove given node from the UI overlay.
removeUINodes(Node...) - Method in class com.almasb.fxgl.scene.GameScene
Remove nodes from the UI overlay.
removeUpdateListener(UpdateListener) - Method in class com.almasb.fxgl.app.GameApplication
 
renderLayer(RenderLayer) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
RenderLayer - Interface in com.almasb.fxgl.entity
Represents a layer which is used to group objects being rendered.
renderLayerProperty() - Method in class com.almasb.fxgl.entity.component.ViewComponent
 
renderLayerProperty() - Method in class com.almasb.fxgl.entity.EntityView
 
renderParticles(GraphicsContext, Point2D) - Method in class com.almasb.fxgl.effect.ParticleControl
Do NOT call manually.
repeat(int) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
reposition(Point2D) - Method in class com.almasb.fxgl.physics.PhysicsControl
Repositions an entity that supports physics directly in the physics world.
reset() - Method in class com.almasb.fxgl.effect.Particle
 
reset() - Method in class com.almasb.fxgl.entity.GameWorld
 
reset() - Method in class com.almasb.fxgl.physics.CollisionResult
 
restore(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Restore component by given value.
RESTORE_SETTINGS - Static variable in class com.almasb.fxgl.saving.LoadEvent
Fired when settings are being restored.
restoreDefaultSettings() - Method in interface com.almasb.fxgl.scene.menu.MenuEventListener
 
restorePercentageCurrent(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Restore component by given percentage.
restorePercentageMax(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Restore by given percentage.
resumeAllMusic() - Method in interface com.almasb.fxgl.service.AudioPlayer
Resumes all currently paused music.
resumeMusic(Music) - Method in interface com.almasb.fxgl.service.AudioPlayer
Resumes previously paused AudioPlayer.pauseMusic(Music) music.
rotate(GameEntity...) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
rotate(List<GameEntity>) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
rotate(double) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
rotateBy(double) - Method in class com.almasb.fxgl.entity.component.RotationComponent
Rotate entity view by given angle.
rotateBy(double) - Method in class com.almasb.fxgl.entity.GameEntity
Rotate entity view by given angle clockwise.
rotateToVector(Point2D) - Method in class com.almasb.fxgl.entity.component.RotationComponent
Set absolute rotation of the entity view to angle between vector and positive X axis.
rotateToVector(Point2D) - Method in class com.almasb.fxgl.entity.GameEntity
Set absolute rotation of the entity view to angle between vector and positive X axis.
RotationComponent - Class in com.almasb.fxgl.entity.component
Adds rotation data to an entity.
RotationComponent() - Constructor for class com.almasb.fxgl.entity.component.RotationComponent
Constructs rotation with angle = 0.
RotationComponent(double) - Constructor for class com.almasb.fxgl.entity.component.RotationComponent
Constructs rotation with given angle.

S

SAT - Class in com.almasb.fxgl.physics
Separating Axis Theorem based check for collision.
save(UserProfile) - Method in interface com.almasb.fxgl.saving.UserProfileSavable
Called during profile save.
SaveEvent - Class in com.almasb.fxgl.saving
Occurs during save.
SaveEvent(UserProfile) - Constructor for class com.almasb.fxgl.saving.SaveEvent
 
saveFileExists(String) - Method in class com.almasb.fxgl.saving.SaveLoadManager
 
saveFiles() - Method in class com.almasb.fxgl.saving.SaveLoadManager
 
SaveLoadManager - Class in com.almasb.fxgl.saving
Convenient access to saving and loading game data.
SaveLoadManager(String) - Constructor for class com.almasb.fxgl.saving.SaveLoadManager
Constructs manager for given profile name.
saveProfileTask(UserProfile) - Method in class com.almasb.fxgl.saving.SaveLoadManager
Saves user profile to "profiles/".
saveScreenshot() - Method in interface com.almasb.fxgl.service.Display
Saves a screenshot of the current scene into a ".png" file.
saveState() - Method in class com.almasb.fxgl.app.GameApplication
Called when MenuEvent.SAVE occurs.
saveTask(DataFile, SaveFile) - Method in class com.almasb.fxgl.saving.SaveLoadManager
Save serializable data onto a disk file system under saves directory, which is created if necessary in the directory where the game is start from.
scale(GameEntity...) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
scanForHandlers(Object) - Method in interface com.almasb.fxgl.service.EventBus
Scan an object for public methods marked @Handles and add them to the event bus.
scanForUserActions(Object) - Method in interface com.almasb.fxgl.service.Input
Given an object, scans its methods for OnUserAction annotation and creates UserActions from its data.
SCENE_FACTORY - Static variable in interface com.almasb.fxgl.service.ServiceType
 
SceneDimension - Class in com.almasb.fxgl.settings
A 2d dimension that describes scene resolution.
SceneDimension(double, double) - Constructor for class com.almasb.fxgl.settings.SceneDimension
Constructs a SceneDimension with the specified width and height.
schedule(Runnable, Duration) - Method in interface com.almasb.fxgl.service.Executor
Schedule a single action to run after delay.
scope() - Method in interface com.almasb.fxgl.service.ServiceType
 
SelectableComponent - Class in com.almasb.fxgl.entity.component
Marks an entity as selectable.
SelectableComponent(boolean) - Constructor for class com.almasb.fxgl.entity.component.SelectableComponent
 
selectedEntityProperty() - Method in class com.almasb.fxgl.entity.GameWorld
 
service() - Method in interface com.almasb.fxgl.service.ServiceType
 
serviceProvider() - Method in interface com.almasb.fxgl.service.ServiceType
 
services - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
ServiceType<T> - Interface in com.almasb.fxgl.service
Marks a service type.
set(Texture) - Method in class com.almasb.fxgl.texture.Texture
Set texture data by copying it from other texture.
setAngularVelocity(double) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set velocity (angle in deg) at which the entity will rotate per tick.
setAnimationChannel(AnimationChannel) - Method in class com.almasb.fxgl.texture.AnimatedTexture
Set animation channel.
setAnimationChannel(AnimationChannel, Runnable) - Method in class com.almasb.fxgl.texture.AnimatedTexture
Set animation channel with a callback to run when the channel ends.
setApplicationMode(ApplicationMode) - Method in class com.almasb.fxgl.settings.GameSettings
Sets application run mode.
setBackgroundColor(Color) - Method in interface com.almasb.fxgl.service.NotificationService
Set background color of notifications.
setBackgroundColor(Paint) - Method in class com.almasb.fxgl.ui.InGameWindow
Set background color of this window.
setBackgroundFill(Paint) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setBlendMode(BlendMode) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Blend function is used to obtain blend mode for particles.
setBodyDef(BodyDef) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set custom body definition to describe a generated body for this physics entity.
setBodyLinearVelocity(Vec2) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set linear velocity for a physics entity.
setBodyType(BodyType) - Method in class com.almasb.fxgl.physics.PhysicsComponent
A convenience method to avoid setting body definition if only a change of body type is required.
setCanGoOffscreen(boolean) - Method in class com.almasb.fxgl.ui.InGameWindow
 
setCloseConfirmation(boolean) - Method in class com.almasb.fxgl.settings.GameSettings
Setting to false will disable asking for confirmation on exit.
setColor(Paint) - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
setColor(Color) - Method in class com.almasb.fxgl.effect.Vignette
Set effect color.
setColor(Color) - Method in class com.almasb.fxgl.physics.PhysicsParticleComponent
Set particle color.
setControl(Consumer<Particle>) - Method in class com.almasb.fxgl.effect.Particle
Set a direct controller to this particle.
setCredits(Credits) - Method in class com.almasb.fxgl.settings.GameSettings
Set additional credits.
setCurrentValue(double) - Method in class com.almasb.fxgl.ui.ProgressBar
Sets the value of the property currentValue.
setCursor(String, Point2D) - Method in class com.almasb.fxgl.scene.FXGLScene
Sets global game cursor using given name to find the image cursor within assets/ui/cursors/.
setDefinition(ParticleGroupDef) - Method in class com.almasb.fxgl.physics.PhysicsParticleComponent
Set particle group definition.
setDirection(Point2D) - Method in class com.almasb.fxgl.entity.control.ProjectileControl
Set direction in which projectile is moving.
setEffect(Effect) - Method in class com.almasb.fxgl.scene.FXGLScene
Applies given effect to the scene.
setEmissionRate(double) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Set the emission rate.
setEnabledMenuItems(EnumSet<MenuItem>) - Method in class com.almasb.fxgl.settings.GameSettings
 
setEndColor(Paint) - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
SetEntityFactory - Annotation Type in com.almasb.fxgl.annotation
Indicates that a class will be used as the main entity factory.
setEntityFactory(EntityFactory) - Method in class com.almasb.fxgl.entity.GameWorld
Set main entity factory to be used via GameWorld.spawn(String, SpawnData).
setExpireFunction(TriFunction<Integer, Double, Double, Duration>) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Expire function is used to obtain expire time for particles.
setFill(Color) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setFill(Color) - Method in class com.almasb.fxgl.ui.ToggleSwitch
 
setFixtureDef(FixtureDef) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set custom fixture definition to describe a generated fixture for this physics entity.
setFullScreen(boolean) - Method in class com.almasb.fxgl.settings.GameSettings
Setting to true will start the game in fullscreen mode.
setGlobalMusicVolume(double) - Method in interface com.almasb.fxgl.service.AudioPlayer
Set global music volume in the range [0..1], where 0 = 0%, 1 = 100%.
setGlobalSoundVolume(double) - Method in interface com.almasb.fxgl.service.AudioPlayer
Set global sound volume in the range [0..1], where 0 = 0%, 1 = 100%.
setGravity(double, double) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Set global world gravity.
setGravityFunction(Supplier<Point2D>) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Set gravity function.
setHeight(int) - Method in class com.almasb.fxgl.settings.GameSettings
Set target height.
setHeight(double) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setIntensity(double) - Method in class com.almasb.fxgl.effect.Vignette
Set effect intensity.
setIntroEnabled(boolean) - Method in class com.almasb.fxgl.settings.GameSettings
If set to true, the intro video/animation will be played before the start of the game.
setLabelFill(Paint) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setLabelPosition(Position) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setLabelVisible(boolean) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setLevel(Level) - Method in class com.almasb.fxgl.entity.GameWorld
Set level to given.
setLevelFromMap(TiledMap) - Method in class com.almasb.fxgl.entity.GameWorld
 
setLinearVelocity(Point2D) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set linear velocity for a physics entity.
setLinearVelocity(double, double) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set linear velocity for a physics entity.
setMaxValue(double) - Method in class com.almasb.fxgl.entity.component.RechargeableComponent
Set max value.
setMaxValue(double) - Method in class com.almasb.fxgl.ui.ProgressBar
Sets the value of the property maxValue.
setMenuEnabled(boolean) - Method in class com.almasb.fxgl.settings.GameSettings
Setting to true enables main and game menu.
setMenuKey(KeyCode) - Method in class com.almasb.fxgl.settings.GameSettings
Set the key that will trigger in-game menu.
setMenuStyle(MenuStyle) - Method in class com.almasb.fxgl.settings.GameSettings
Set the menu style to use.
setMinValue(double) - Method in class com.almasb.fxgl.ui.ProgressBar
Sets the value of the property minValue.
setNumParticles(int) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Set number of particles being spawned per emission.
setOnClose(Runnable) - Method in class com.almasb.fxgl.scene.FXGLMenu.MenuContent
Set on close handler.
setOnOpen(Runnable) - Method in class com.almasb.fxgl.scene.FXGLMenu.MenuContent
Set on open handler.
setOnPhysicsInitialized(Runnable) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set a callback to run when this entity has been added to physics world.
setPosition(Point2D) - Method in class com.almasb.fxgl.entity.GameEntity
Set top left position of this entity in world coordinates.
setPosition(Position) - Method in interface com.almasb.fxgl.service.NotificationService
Set position of future notifications.
setPosition(double, double) - Method in class com.almasb.fxgl.ui.InGameWindow
Set top-left position of the window.
setProcessInput(boolean) - Method in interface com.almasb.fxgl.service.Input
Setting to false will disable processing of input events.
setProfilingEnabled(boolean) - Method in class com.almasb.fxgl.settings.GameSettings
Setting to true will enable profiler that reports on performance when FXGL exits.
setRadius(double) - Method in class com.almasb.fxgl.effect.Vignette
Set gradient radius.
setRaycastIgnored(boolean) - Method in class com.almasb.fxgl.physics.PhysicsComponent
Set true to make raycast ignore this entity.
setRegisterInput(boolean) - Method in interface com.almasb.fxgl.service.Input
Setting to false will disable capturing of input events.
setRenderLayer(RenderLayer) - Method in class com.almasb.fxgl.entity.component.ViewComponent
Set render layer.
setRenderLayer(RenderLayer) - Method in class com.almasb.fxgl.entity.EntityView
Set render layer for this entity.
setRenderLayer(RenderLayer) - Method in class com.almasb.fxgl.entity.GameEntity
Set render layer.
setRotation(double) - Method in class com.almasb.fxgl.entity.GameEntity
Set absolute rotation angle.
setScaleFunction(TriFunction<Integer, Double, Double, Point2D>) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Scale function defines how the size of particles change over time.
setScaleX(double) - Method in class com.almasb.fxgl.entity.GameEntity
Set view scale X.
setScaleY(double) - Method in class com.almasb.fxgl.entity.GameEntity
Set view scale Y.
setScene(FXGLScene) - Method in interface com.almasb.fxgl.service.Display
Set current FXGL scene.
setSceneDimension(SceneDimension) - Method in interface com.almasb.fxgl.service.Display
Set new scene dimension.
setShowBBoxColor(Color) - Static method in class com.almasb.fxgl.entity.component.ViewComponent
 
setSize(double, double) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Set size to particles.
setSnapToScreen(boolean) - Method in class com.almasb.fxgl.ui.InGameWindow
 
setSnapToWindows(boolean) - Method in class com.almasb.fxgl.ui.InGameWindow
 
setSourceImage(Image) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Set source image for this emitter to produce particles.
setSpawnPointFunction(TriFunction<Integer, Double, Double, Point2D>) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Particles will use the function to obtain spawn points.
setSpeed(double) - Method in class com.almasb.fxgl.entity.control.ProjectileControl
 
setStartColor(Paint) - Method in class com.almasb.fxgl.effect.ParticleEmitter
 
setTexture(String) - Method in class com.almasb.fxgl.entity.component.ViewComponent
Convenience method to set texture as view.
setTexture(String, boolean) - Method in class com.almasb.fxgl.entity.component.ViewComponent
Convenience method to set texture as view.
setTitle(String) - Method in class com.almasb.fxgl.settings.GameSettings
Set title of the game.
setTraceFill(Paint) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setUIMouseTransparent(boolean) - Method in class com.almasb.fxgl.scene.GameScene
Set true if UI elements should forward mouse events to the game layer.
setValue(double, double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Set position.
setValue(Point2D) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Set position.
setVelocityFunction(TriFunction<Integer, Double, Double, Point2D>) - Method in class com.almasb.fxgl.effect.ParticleEmitter
Set initial velocity function.
setVelocityX(double) - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
setVelocityY(double) - Method in class com.almasb.fxgl.physics.PhysicsComponent
 
setVersion(String) - Method in class com.almasb.fxgl.settings.GameSettings
Set version of the game.
setView(Node) - Method in class com.almasb.fxgl.entity.component.ViewComponent
Set view without generating bounding boxes from view.
setView(Node, boolean) - Method in class com.almasb.fxgl.entity.component.ViewComponent
Set view.
setView(Node) - Method in class com.almasb.fxgl.entity.GameEntity
Set view without generating bounding boxes from view.
setViewFromTexture(String) - Method in class com.almasb.fxgl.entity.GameEntity
Set view from texture.
setViewFromTextureWithBBox(String) - Method in class com.almasb.fxgl.entity.GameEntity
Set view from texture and generate bbox from it.
setViewWithBBox(Node) - Method in class com.almasb.fxgl.entity.GameEntity
Set view and generate bounding boxes from view.
setWidth(int) - Method in class com.almasb.fxgl.settings.GameSettings
Set target width.
setWidth(double) - Method in class com.almasb.fxgl.ui.ProgressBar
 
setX(double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Set x.
setX(double) - Method in class com.almasb.fxgl.entity.GameEntity
Set position x of this entity.
setY(double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Set y.
setY(double) - Method in class com.almasb.fxgl.entity.GameEntity
Set position y of this entity.
showBox(String, Node, Button...) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) generic dialog.
showConfirmationBox(String, Consumer<Boolean>) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking message box with YES and NO buttons.
showErrorBox(Throwable) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) dialog with the error.
showErrorBox(String, Runnable) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) dialog with the error.
showInputBox(String, Consumer<String>) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) message box with OK button and input field.
showInputBox(String, Predicate<String>, Consumer<String>) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) message box with OK button and input field.
showInputBoxWithCancel(String, Predicate<String>, Consumer<String>) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) message box with OK and CANCEL buttons and input field.
showMessageBox(String) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) message box with OK button.
showMessageBox(String, Runnable) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) message box with OK button.
showProgressBox(String) - Method in interface com.almasb.fxgl.service.Display
Shows a blocking (stops game execution, method returns normally) progress dialog.
spawn(SpawnData) - Method in interface com.almasb.fxgl.entity.EntitySpawner
 
spawn(String) - Method in class com.almasb.fxgl.entity.GameWorld
 
spawn(String, Point2D) - Method in class com.almasb.fxgl.entity.GameWorld
Creates an entity with given name at x, y using specified entity factory.
spawn(String, double, double) - Method in class com.almasb.fxgl.entity.GameWorld
Creates an entity with given name at x, y using specified entity factory.
spawn(String, SpawnData) - Method in class com.almasb.fxgl.entity.GameWorld
Creates an entity with given name and data using specified entity factory.
Spawns - Annotation Type in com.almasb.fxgl.annotation
Indicates that a method is used for creating entities.
SpawnSymbol - Annotation Type in com.almasb.fxgl.annotation
Indicates that a method is used for creating entities when using TextEntityFactory.
start(Stage) - Method in class com.almasb.fxgl.app.GameApplication
This is the main entry point as run by the JavaFX platform.
start(Consumer<Boolean>, Duration, KeyCode...) - Method in interface com.almasb.fxgl.service.QTE
Starts quick time event.
startNewGame() - Method in class com.almasb.fxgl.app.GameApplication
(Re-)initializes the user application as new and starts the game.
State - Class in com.almasb.fxgl.app
A single state in which an application can be.
State() - Constructor for class com.almasb.fxgl.app.State
 
StateListener - Interface in com.almasb.fxgl.app.listener
 
stop() - Method in class com.almasb.fxgl.app.GameApplication
 
stopAllMusic() - Method in interface com.almasb.fxgl.service.AudioPlayer
Stops all currently playing music.
stopAllSounds() - Method in interface com.almasb.fxgl.service.AudioPlayer
Stops playing all sounds.
stopMusic(Music) - Method in interface com.almasb.fxgl.service.AudioPlayer
Stops currently playing music.
stopSound(Sound) - Method in interface com.almasb.fxgl.service.AudioPlayer
Stops playing given sound.
SubState - Class in com.almasb.fxgl.app
 
SubState() - Constructor for class com.almasb.fxgl.app.SubState
 
subTexture(Rectangle2D) - Method in class com.almasb.fxgl.texture.Texture
Given a rectangular area, produces a sub-texture of this texture.
superTexture(Texture, HorizontalDirection) - Method in class com.almasb.fxgl.texture.Texture
Generates a new texture which combines this and given texture.
superTexture(Texture, VerticalDirection) - Method in class com.almasb.fxgl.texture.Texture
Generates a new texture which combines this and given texture.
switchedOnProperty() - Method in class com.almasb.fxgl.ui.ToggleSwitch
 
switchMenuContentTo(Node) - Method in class com.almasb.fxgl.scene.FXGLMenu
Switches current active content to given.
switchMenuContentTo(Node) - Method in class com.almasb.fxgl.scene.menu.CCTRMenu
 
switchMenuContentTo(Node) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
switchMenuContentTo(Node) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
 
switchMenuTo(Node) - Method in class com.almasb.fxgl.scene.FXGLMenu
Switches current active menu body to given.
switchMenuTo(Node) - Method in class com.almasb.fxgl.scene.menu.FXGLDefaultMenu
 
switchMenuTo(Node) - Method in class com.almasb.fxgl.scene.menu.GTAVMenu
 

T

TextEntityFactory - Interface in com.almasb.fxgl.entity
Marks a class that it's able to spawn entities from text-based levels.
Texture - Class in com.almasb.fxgl.texture
Represents a 2D image which can be set as view for an entity.
Texture(Image) - Constructor for class com.almasb.fxgl.texture.Texture
Constructs new texture from given image.
title - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
to(Class<T>) - Method in class com.almasb.fxgl.parser.KVFile
Converts an instance of KVFile to instance of the data structure and populates its fields with appropriate values.
toAnimatedTexture(int, Duration) - Method in class com.almasb.fxgl.texture.Texture
Converts the texture to animated texture.
toAnimatedTexture(AnimationChannel) - Method in class com.almasb.fxgl.texture.Texture
Converts the texture to animated texture.
toColor(Color) - Method in class com.almasb.fxgl.texture.Texture
Colorizes this texture's pixels with given color.
ToggleSwitch - Class in com.almasb.fxgl.ui
On/Off toggle switch.
ToggleSwitch() - Constructor for class com.almasb.fxgl.ui.ToggleSwitch
 
toGrayscale() - Method in class com.almasb.fxgl.texture.Texture
 
toMeters(double) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Converts pixels to meters
TOP - Static variable in interface com.almasb.fxgl.entity.RenderLayer
Default render layer for entities with no specified render layer.
toPixels(double) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Converts meters to pixels
toPoint(Point2D) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Converts a point in pixel space to a point in physics space.
toPoint(Vec2) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Converts a point in physics space to a point in pixel space.
toReadOnly() - Method in class com.almasb.fxgl.settings.GameSettings
 
toString() - Method in class com.almasb.fxgl.app.State
 
toString() - Method in class com.almasb.fxgl.entity.component.HealthComponent
 
toString() - Method in class com.almasb.fxgl.entity.component.IDComponent
 
toString() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
toString() - Method in class com.almasb.fxgl.entity.component.RotationComponent
 
toString() - Method in class com.almasb.fxgl.entity.component.TypeComponent
 
toString() - Method in class com.almasb.fxgl.entity.component.ViewComponent
 
toString() - Method in class com.almasb.fxgl.entity.EntityEvent
 
toString() - Method in class com.almasb.fxgl.entity.GameEntity
 
toString() - Method in class com.almasb.fxgl.gameplay.AchievementEvent
 
toString() - Method in class com.almasb.fxgl.gameplay.AchievementProgressEvent
 
toString() - Method in class com.almasb.fxgl.gameplay.NotificationEvent
 
toString() - Method in class com.almasb.fxgl.input.UserAction
 
toString() - Method in class com.almasb.fxgl.parser.KVFile
 
toString() - Method in class com.almasb.fxgl.saving.LoadEvent
 
toString() - Method in class com.almasb.fxgl.saving.SaveEvent
 
toString() - Method in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
toString() - Method in class com.almasb.fxgl.settings.SceneDimension
 
toString() - Method in class com.almasb.fxgl.texture.Texture
 
toVector(Point2D) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Converts a vector of type Point2D to vector of type Vec2
toVector(Vec2) - Method in class com.almasb.fxgl.physics.PhysicsWorld
Converts a vector of type Vec2 to vector of type Point2D
tpf() - Method in class com.almasb.fxgl.app.GameApplication
 
translate(GameEntity...) - Method in class com.almasb.fxgl.entity.animation.AnimationBuilder
 
translate(double, double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Translate x and y by given values.
translate(Point2D) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Translate x and y by given vector.
translate(Point2D) - Method in class com.almasb.fxgl.entity.GameEntity
Translate x and y by given vector.
translate(Vec2) - Method in class com.almasb.fxgl.entity.GameEntity
Translate x and y by given vector.
translate(double, double) - Method in class com.almasb.fxgl.entity.GameEntity
Translate x and y by given vector.
translate(double, double) - Method in class com.almasb.fxgl.physics.HitBox
Computes new bounds based on translated X and Y of an entity.
translateTowards(Point2D, double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
translateTowards(Point2D, double) - Method in class com.almasb.fxgl.entity.GameEntity
 
translateX(double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Translate X by given value.
translateX(double) - Method in class com.almasb.fxgl.entity.GameEntity
Translate X by given value.
translateXFlipped(double, double, double) - Method in class com.almasb.fxgl.physics.HitBox
Computes new bounds based on translated X and Y of an entity with X axis being flipped.
translateY(double) - Method in class com.almasb.fxgl.entity.component.PositionComponent
Translate Y by given value.
translateY(double) - Method in class com.almasb.fxgl.entity.GameEntity
Translate Y by given value.
TriFunction<T,U,V,R> - Interface in com.almasb.fxgl.util
Represents a function that accepts three arguments and produces a result.
turnOnDebugBBox(boolean) - Method in class com.almasb.fxgl.entity.component.ViewComponent
Turn on / off bounding box display.
type(Enum<?>) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
type - Variable in class com.almasb.fxgl.scene.FXGLMenu
 
TypeComponent - Class in com.almasb.fxgl.entity.component
Represents an entity type.
TypeComponent() - Constructor for class com.almasb.fxgl.entity.component.TypeComponent
Constructs a component with no type.
TypeComponent(Serializable) - Constructor for class com.almasb.fxgl.entity.component.TypeComponent
Constructs a component with given type.

U

UI_FACTORY - Static variable in interface com.almasb.fxgl.service.ServiceType
 
UIFactory - Interface in com.almasb.fxgl.service
Factory service for creating UI controls.
unbind() - Method in class com.almasb.fxgl.physics.HitBox
Unbind the hit box.
UpdateListener - Interface in com.almasb.fxgl.app.listener
 
UserAction - Class in com.almasb.fxgl.input
Represents a user action which is typically triggered when a key or a mouse event has occurred.
UserAction(String) - Constructor for class com.almasb.fxgl.input.UserAction
Constructs new user action with given name.
UserProfile - Class in com.almasb.fxgl.saving
User profile can store various preference settings like resolution, volume, etc.
UserProfile(String, String) - Constructor for class com.almasb.fxgl.saving.UserProfile
Constructs an empty user profile with given app title and version.
UserProfileSavable - Interface in com.almasb.fxgl.saving
Allows services to save/load their state using a user profile.

V

valueOf(String) - Static method in enum com.almasb.fxgl.scene.menu.MenuStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.almasb.fxgl.settings.MenuItem
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.almasb.fxgl.ui.InGameWindow.WindowDecor
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.almasb.fxgl.ui.Position
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.almasb.fxgl.scene.menu.MenuStyle
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.almasb.fxgl.settings.MenuItem
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.almasb.fxgl.ui.InGameWindow.WindowDecor
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.almasb.fxgl.ui.Position
Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
Version - Class in com.almasb.fxgl.util
Holds version info about various frameworks used in FXGL.
ViewComponent - Class in com.almasb.fxgl.entity.component
Adds a game scene view to an entity.
ViewComponent() - Constructor for class com.almasb.fxgl.entity.component.ViewComponent
Creates view component with no graphics.
ViewComponent(Node) - Constructor for class com.almasb.fxgl.entity.component.ViewComponent
Creates view component with given graphics.
ViewComponent(RenderLayer) - Constructor for class com.almasb.fxgl.entity.component.ViewComponent
Creates view component with given render layer.
ViewComponent(Node, RenderLayer) - Constructor for class com.almasb.fxgl.entity.component.ViewComponent
Creates view component with given graphics and given render layer.
viewFromNode(Node) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
viewFromNodeWithBBox(Node) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
viewFromTexture(String) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
viewFromTextureWithBBox(String) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
viewFromTiles(TiledMap, String) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
Generates view from tiles with RenderLayer.TOP.
viewFromTiles(TiledMap, String, RenderLayer) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
Generates view from tiles.
Vignette - Class in com.almasb.fxgl.effect
Vignette effect node.
Vignette(int, int, double) - Constructor for class com.almasb.fxgl.effect.Vignette
Constructs new vignette effect with given values

W

width - Variable in class com.almasb.fxgl.settings.ReadOnlyGameSettings
 
widthProperty() - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
with(Component...) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
with(Control...) - Method in class com.almasb.fxgl.entity.Entities.GameEntityBuilder
 
write(Bundle) - Method in class com.almasb.fxgl.entity.component.BoundingBoxComponent
 
write(Bundle) - Method in class com.almasb.fxgl.entity.component.IDComponent
 
write(Bundle) - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
write(Bundle) - Method in class com.almasb.fxgl.entity.component.TypeComponent
 

X

xProperty() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 

Y

yProperty() - Method in class com.almasb.fxgl.entity.component.PositionComponent
 
A B C D E F G H I J K L M N O P Q R S T U V W X Y 
Skip navigation links

Copyright © 2017. All rights reserved.