com.almasb.fxgl.entity.component.Component Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fxgl-entity Show documentation

There is a newer version: 21.1

/*
 * FXGL - JavaFX Game Library. The MIT License (MIT).
 * Copyright (c) AlmasB ([email protected]).
 * See LICENSE for details.
 */

package com.almasb.fxgl.entity.component;

import com.almasb.fxgl.entity.Entity;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;

/**
 * A component is used to add data and behavior to an entity.
 *
 * @author Almas Baimagambetov ([email protected])
 */
public abstract class Component {

    protected Entity entity;

    private BooleanProperty paused = new SimpleBooleanProperty(false);

    /**
     * @return entity to which this component is attached
     */
    public final Entity getEntity() {
        return entity;
    }

    final void setEntity(Entity entity) {
        this.entity = entity;
    }

    public final boolean isPaused() {
        return paused.getValue();
    }

    public final void pause() {
        paused.setValue(true);
    }

    public final void resume() {
        paused.setValue(false);
    }

    public BooleanProperty pausedProperty() {
        return paused;
    }

    /**
     * Called after the component is added to entity.
     */
    public void onAdded() {

    }

    /**
     * Called each frame when not paused.
     *
     * @param tpf time per frame
     */
    public void onUpdate(double tpf) {

    }

    /**
     * Called before the component is removed from entity.
     */
    public void onRemoved() {

    }

    /**
     * To gain performance during entity creation / component addition, you can override this to return false.
     * Then components will not be injected, so you will need to manage dependencies manually.
     * You can do so in onAdded().
     *
     * @return whether this component requires injection of other components into it (default true)
     */
    public boolean isComponentInjectionRequired() {
        return true;
    }

    @Override
    public String toString() {
        String simpleName = getClass().getSimpleName();

        int index = simpleName.indexOf("Component");

        if (index != -1) {
            simpleName = simpleName.substring(0, index);
        }

        return simpleName + "()";
    }
}