com.almasb.fxgl.entity.Spawns 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;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Indicates that a method is used for creating entities.
 * Note: the method signature must be public Entity anyName(SpawnData).
 *
 * @author Almas Baimagambetov ([email protected])
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Spawns {

    /**
     * @return name/type of the entity that this method spawns
     */
    String value();
}