FlagDefinition.java

package net.alcuria.umbracraft.definitions;

import net.alcuria.umbracraft.Game;
import net.alcuria.umbracraft.annotations.Tooltip;

/** Defines a flag (or "switch" in RPG Maker 2003 terms) that is toggled during
 * scripted events. This definition is stateless. All run-time changes to flags
 * are maintained in the {@link Game} class.
 * @author Andrew Keturi */
public class FlagDefinition extends Definition {

	@Tooltip("A reminder for the purpose of the flag. Not shown ingame.")
	public String description;
	@Tooltip("A unique id")
	public String id;
	@Tooltip("A tag for sorting")
	public String tag;

	@Override
	public String getName() {
		return id;
	}

	@Override
	public String getTag() {
		return tag != null ? tag : "";
	}

}