com.almasb.fxgl.gameplay

Class Achievement

java.lang.Object

com.almasb.fxgl.gameplay.Achievement

public class Achievement
extends Object

A game achievement.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyBooleanProperty	achieved

Constructor Summary

Constructors

Constructor and Description
Achievement(String name, String description) Constructs a new achievement with given name and description.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.ReadOnlyBooleanProperty	achievedProperty()
void	bind(javafx.beans.binding.BooleanBinding binding) Binds achievement to given binding (condition).
void	bind(javafx.beans.property.IntegerProperty property, int value) Bind achievement condition to given property.
String	getDescription() Returns description.
String	getName()
boolean	isAchieved()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

achieved

public javafx.beans.property.ReadOnlyBooleanProperty achievedProperty

See Also:

isAchieved()

Constructor Detail

Achievement

public Achievement(String name,
                   String description)

Constructs a new achievement with given name and description.

Parameters:

name - the name

description - the description on how to unlock achievement

Method Detail

isAchieved

public boolean isAchieved()

Returns:

true iff the achievement has been unlocked

achievedProperty

public javafx.beans.property.ReadOnlyBooleanProperty achievedProperty()

See Also:

isAchieved()

bind

public void bind(javafx.beans.binding.BooleanBinding binding)

Binds achievement to given binding (condition). No-op if achievement is already unlocked.

Parameters:

binding - condition on which achievement is unlocked

bind

public void bind(javafx.beans.property.IntegerProperty property,
                 int value)

Bind achievement condition to given property.

Parameters:

property - the property

value - the value at which the achievement is unlocked

getName

public String getName()

Returns:

achievement name

getDescription

public String getDescription()

Returns description. This usually contains info on how to unlock the achievement.

Returns:

achievement description

toString

public String toString()

Overrides:

toString in class Object