Package net.fateuhc.plugin.api.data

Class ScenarioData

java.lang.Object

net.fateuhc.plugin.api.data.ScenarioData

public class ScenarioData
extends Object

Constructor Summary

Constructors

Constructor	Description
ScenarioData(boolean enabled, com.cryptomorin.xseries.XMaterial material, boolean lobbyModeOnlyEdit, String alias, String name, String... description)	Deprecated. Please use ScenarioData(boolean, Material, boolean, String, String, String...) as the relocation of XSeries breaks this method.
ScenarioData(boolean enabled, com.cryptomorin.xseries.XMaterial material, String alias, String name, String... description)	Deprecated. Please use ScenarioData(boolean, Material, String, String, String...) as the relocation of XSeries breaks this method.
ScenarioData(boolean enabled, org.bukkit.Material material, boolean lobbyModeOnlyEdit, String alias, String name, String... description)	Create a ScenarioData.
ScenarioData(boolean enabled, org.bukkit.Material material, String alias, String name, String... description)	Create a ScenarioData.

Method Summary

Modifier and Type	Method	Description
String	getAlias()	Get the alias of the Scenario.
String[]	getDescription()	Get the description of the Scenario.
String	getName()	Get the name of the Scenario.
boolean	isActive()	Is the scenario active?
boolean	isEnabled()	Is the Scenario be able to be enabled by servers.
boolean	isLobbyModeOnlyEdit()	Is the Scenario only able to be edited in the lobby?
org.bukkit.inventory.ItemStack	toItemStack()	Get the item stack for the scenario.

Methods inherited from class java.lang.Object

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

Constructor Details

ScenarioData

@Deprecated
public ScenarioData(boolean enabled,
 com.cryptomorin.xseries.XMaterial material,
 String alias,
 String name,
 String... description)

Deprecated.

Please use ScenarioData(boolean, Material, String, String, String...) as the relocation of XSeries breaks this method.

Create a ScenarioData.

Parameters:

enabled - Should the Scenario be enabled for servers to use?

material - What material should the Scenario show as?

alias - What is the alias for the Scenario?

name - What is the name of the Scenario?

description - What is the description of the Scenario?

ScenarioData

@Deprecated
public ScenarioData(boolean enabled,
 com.cryptomorin.xseries.XMaterial material,
 boolean lobbyModeOnlyEdit,
 String alias,
 String name,
 String... description)

Deprecated.

Please use ScenarioData(boolean, Material, boolean, String, String, String...) as the relocation of XSeries breaks this method.

Create a ScenarioData.

Parameters:

enabled - Should the Scenario be enabled for servers to use?

material - What material should the Scenario show as?

lobbyModeOnlyEdit - Should the scenario only be able to be enabled from the lobby?

alias - What is the alias for the Scenario?

name - What is the name of the Scenario?

description - What is the description of the Scenario?

ScenarioData

public ScenarioData(boolean enabled,
 org.bukkit.Material material,
 String alias,
 String name,
 String... description)

Create a ScenarioData.

Parameters:

enabled - Should the Scenario be enabled for servers to use?

material - What material should the Scenario show as?

alias - What is the alias for the Scenario?

name - What is the name of the Scenario?

description - What is the description of the Scenario?

ScenarioData

public ScenarioData(boolean enabled,
 org.bukkit.Material material,
 boolean lobbyModeOnlyEdit,
 String alias,
 String name,
 String... description)

Create a ScenarioData.

Parameters:

enabled - Should the Scenario be enabled for servers to use?

material - What material should the Scenario show as?

lobbyModeOnlyEdit - Should the scenario only be able to be enabled from the lobby?

alias - What is the alias for the Scenario?

name - What is the name of the Scenario?

description - What is the description of the Scenario?

Method Details

isEnabled

public boolean isEnabled()

Is the Scenario be able to be enabled by servers.

Returns:

Boolean

getName

public String getName()

Get the name of the Scenario.

Returns:

String

getAlias

public String getAlias()

Get the alias of the Scenario.

Returns:

String

isActive

public boolean isActive()

Is the scenario active?

Returns:

Boolean

getDescription

public String[] getDescription()

Get the description of the Scenario.

Returns:

invalid @link

{@link String[

}

isLobbyModeOnlyEdit

public boolean isLobbyModeOnlyEdit()

Is the Scenario only able to be edited in the lobby?

Returns:

Boolean

toItemStack

public org.bukkit.inventory.ItemStack toItemStack()

Get the item stack for the scenario.

Returns:

ItemStack