com.github.ucchyocean.lc
インタフェース LunaChatAPI

既知の実装クラスの一覧:

ChannelManager

public interface LunaChatAPI

LunaChat APIクラス

作成者:

ucchy

メソッドの概要

void	addHidelist(ChannelPlayer player, ChannelPlayer hided) 指定されたプレイヤーが、指定されたプレイヤーをhideするように設定する。
Channel	createChannel(String channelName) 新しいチャンネルを作成する
Channel	createChannel(String channelName, org.bukkit.command.CommandSender sender) 新しいチャンネルを作成する
HashMap<String,String>	getAllDictionary() 辞書データを全て取得する
Channel	getChannel(String channelName) チャンネルを取得する
Collection<Channel>	getChannels() 全てのチャンネルを返す
Collection<Channel>	getChannelsByPlayer(String playerName) プレイヤーが参加しているチャンネルを返す
Channel	getDefaultChannel(String playerName) プレイヤーが参加しているデフォルトのチャンネルを返す
ArrayList<ChannelPlayer>	getHideinfo(ChannelPlayer player) 該当のプレイヤーがhideしているプレイヤーのリストを返す。
List<ChannelPlayer>	getHidelist(ChannelPlayer key) 該当のプレイヤーに関連するhidelistを取得する。
String	getTemplate(String id) テンプレートを取得する
boolean	isExistChannel(String channelName) 指定したチャンネル名が存在するかどうかを返す
boolean	isPlayerJapanize(String playerName) プレイヤーのJapanize設定を返す
String	japanize(String message, JapanizeType type) Japanize変換を行う
void	reloadAllData() LunaChatの全データを再読み込みする
boolean	removeChannel(String channelName) チャンネルを削除する
boolean	removeChannel(String channelName, org.bukkit.command.CommandSender sender) チャンネルを削除する
void	removeDefaultChannel(String playerName) 指定した名前のプレイヤーに設定されている、デフォルトチャンネルを削除する
void	removeDictionary(String key) 指定したキーの辞書データを削除する
void	removeHidelist(ChannelPlayer player, ChannelPlayer hided) 指定されたプレイヤーが、指定されたプレイヤーのhideを解除するように設定する。
void	removeTemplate(String id) テンプレートを削除する
void	setDefaultChannel(String playerName, String channelName) プレイヤーのデフォルトチャンネルを設定する
void	setDictionary(String key, String value) 新しい辞書データを追加する
void	setPlayersJapanize(String playerName, boolean doJapanize) 該当プレイヤーのJapanize変換をオン/オフする
void	setTemplate(String id, String template) テンプレートを登録する

メソッドの詳細

isExistChannel

boolean isExistChannel(String channelName)

指定したチャンネル名が存在するかどうかを返す

パラメータ:

channelName - チャンネル名

戻り値:

存在するかどうか

getChannels

Collection<Channel> getChannels()

全てのチャンネルを返す

戻り値:

全てのチャンネル

getChannelsByPlayer

Collection<Channel> getChannelsByPlayer(String playerName)

プレイヤーが参加しているチャンネルを返す

パラメータ:

playerName - プレイヤー名

戻り値:

チャンネル

getDefaultChannel

Channel getDefaultChannel(String playerName)

プレイヤーが参加しているデフォルトのチャンネルを返す

パラメータ:

playerName - プレイヤー

戻り値:

チャンネル

setDefaultChannel

void setDefaultChannel(String playerName,
                       String channelName)

プレイヤーのデフォルトチャンネルを設定する

パラメータ:

playerName - プレイヤー

channelName - チャンネル名

removeDefaultChannel

void removeDefaultChannel(String playerName)

指定した名前のプレイヤーに設定されている、デフォルトチャンネルを削除する

パラメータ:

playerName - プレイヤー名

getChannel

Channel getChannel(String channelName)

チャンネルを取得する

パラメータ:

channelName - チャンネル名

戻り値:

チャンネル

createChannel

Channel createChannel(String channelName)

新しいチャンネルを作成する

パラメータ:

channelName - チャンネル名

戻り値:

作成されたチャンネル

createChannel

Channel createChannel(String channelName,
                      org.bukkit.command.CommandSender sender)

新しいチャンネルを作成する

パラメータ:

channelName - チャンネル名

sender - チャンネルを作成した人

戻り値:

作成されたチャンネル

removeChannel

boolean removeChannel(String channelName)

チャンネルを削除する

パラメータ:

channelName - 削除するチャンネル名

戻り値:

削除したかどうか

removeChannel

boolean removeChannel(String channelName,
                      org.bukkit.command.CommandSender sender)

チャンネルを削除する

パラメータ:

channelName - 削除するチャンネル名

sender - チャンネルを削除した人

戻り値:

削除したかどうか

getTemplate

String getTemplate(String id)

テンプレートを取得する

パラメータ:

id - テンプレートID

戻り値:

テンプレート

setTemplate

void setTemplate(String id,
                 String template)

テンプレートを登録する

パラメータ:

id - テンプレートID

template - テンプレート

removeTemplate

void removeTemplate(String id)

テンプレートを削除する

パラメータ:

id - テンプレートID

getAllDictionary

HashMap<String,String> getAllDictionary()

辞書データを全て取得する

戻り値:

辞書データ

setDictionary

void setDictionary(String key,
                   String value)

新しい辞書データを追加する

パラメータ:

key - キー

value - 値

removeDictionary

void removeDictionary(String key)

指定したキーの辞書データを削除する

パラメータ:

key - キー

getHidelist

List<ChannelPlayer> getHidelist(ChannelPlayer key)

該当のプレイヤーに関連するhidelistを取得する。

パラメータ:

key - プレイヤー

戻り値:

指定されたプレイヤーをhideしているプレイヤー(非null)

getHideinfo

ArrayList<ChannelPlayer> getHideinfo(ChannelPlayer player)

該当のプレイヤーがhideしているプレイヤーのリストを返す。

パラメータ:

player - プレイヤー

戻り値:

指定したプレイヤーがhideしているプレイヤーのリスト

addHidelist

void addHidelist(ChannelPlayer player,
                 ChannelPlayer hided)

指定されたプレイヤーが、指定されたプレイヤーをhideするように設定する。

パラメータ:

player - hideする側のプレイヤー

hided - hideされる側のプレイヤー

removeHidelist

void removeHidelist(ChannelPlayer player,
                    ChannelPlayer hided)

指定されたプレイヤーが、指定されたプレイヤーのhideを解除するように設定する。

パラメータ:

player - hideしていた側のプレイヤー

hided - hideされていた側のプレイヤー

japanize

String japanize(String message,
                JapanizeType type)

Japanize変換を行う

パラメータ:

message - 変換するメッセージ

type - 変換タイプ

戻り値:

変換後のメッセージ、ただしイベントでキャンセルされた場合はnullが返されるので注意

setPlayersJapanize

void setPlayersJapanize(String playerName,
                        boolean doJapanize)

該当プレイヤーのJapanize変換をオン/オフする

パラメータ:

playerName - 設定するプレイヤー名

doJapanize - Japanize変換するかどうか

isPlayerJapanize

boolean isPlayerJapanize(String playerName)

プレイヤーのJapanize設定を返す

パラメータ:

playerName - プレイヤー名

戻り値:

Japanize設定

reloadAllData

void reloadAllData()

LunaChatの全データを再読み込みする