com.github.ucchyocean.lc.channel
クラス Channel

java.lang.Object
  com.github.ucchyocean.lc.channel.Channel

すべての実装されたインタフェース:

org.bukkit.configuration.serialization.ConfigurationSerializable

直系の既知のサブクラス:

ChannelImpl

public abstract class Channel
extends Object
implements org.bukkit.configuration.serialization.ConfigurationSerializable

チャンネル

作成者:

ucchy

メソッドの概要

void	addMember(ChannelPlayer player) メンバーを追加する
void	addModerator(ChannelPlayer player) モデレータを追加する
abstract void	chat(ChannelPlayer player, String message) このチャットに発言をする
abstract void	chatFromOtherSource(String player, String source, String message) ほかの連携先などから、このチャットに発言する
abstract void	checkExpires() 期限付きBanや期限付きMuteをチェックし、期限が切れていたら解除を行う
static Channel	deserialize(Map<String,Object> data) デシリアライズ ConfigurationSerializable互換のための実装。
String	getAlias() チャンネルの別名を返す
Map<ChannelPlayer,Long>	getBanExpires() 期限付きBANの期限マップを返す（key=プレイヤー名、value=期日（ミリ秒））
List<ChannelPlayer>	getBanned() チャンネルのBANリストを返す
int	getChatRange() チャットの可聴範囲、0の場合は無制限
String	getColorCode() チャンネルのカラーコードを返す
String	getDescription() チャンネルの説明文を返す
String	getFormat() チャンネルのメッセージフォーマットを返す
List<ChannelPlayer>	getHided() 非表示プレイヤーの一覧を返す
abstract ArrayList<String>	getInfo(boolean forModerator) チャンネル情報を返す
JapanizeType	getJapanizeType() Japanize変換設定を取得する
abstract ArrayList<String>	getLog(String player, String filter, String date, boolean reverse) ログファイルを読み込んで、ログデータを取得する
List<ChannelPlayer>	getMembers() チャンネルのメンバーを返す
List<ChannelPlayer>	getModerator() チャンネルのモデレーターを返す
List<ChannelPlayer>	getMuted() チャンネルのMuteリストを返す
Map<ChannelPlayer,Long>	getMuteExpires() 期限付きMuteの期限マップを返す（key=プレイヤー名、value=期日（ミリ秒））
String	getName() チャンネル名を返す
int	getOnlineNum() チャンネルのオンライン人数を返す
String	getPassword() チャンネルのパスワードを返す
String	getPrivateMessageTo() 1:1チャットのときに、会話の相手先を取得する
int	getTotalNum() チャンネルの総参加人数を返す
boolean	hasModeratorPermission(org.bukkit.command.CommandSender sender) このチャンネルのモデレータ権限を持っているかどうかを確認する
boolean	isAllowCC() カラーコードが使用可能な設定かどうか
boolean	isBroadcastChannel() ブロードキャストチャンネルかどうか
boolean	isForceJoinChannel() 強制参加チャンネルかどうか
boolean	isGlobalChannel() グローバルチャンネルかどうか
boolean	isPersonalChat() 1:1チャットかどうか
boolean	isVisible() チャンネルの可視性を返す
boolean	isWorldRange() ワールドチャットかどうか
void	removeMember(ChannelPlayer player) メンバーを削除する
void	removeModerator(ChannelPlayer player) モデレータを削除する
boolean	save() チャンネルの情報をファイルに保存する。
abstract void	sendMessage(ChannelPlayer player, String message, String format, boolean sendDynmap, String displayName) メッセージを表示します。
Map<String,Object>	serialize() シリアライズ ConfigurationSerializable互換のための実装。
void	setAlias(String alias) チャンネルの別名を設定する
void	setAllowCC(boolean allowcc) カラーコードの使用可否を設定する
void	setBroadcast(boolean broadcast) ブロードキャストチャンネルを設定する
void	setChatRange(int range) チャットの可聴範囲を設定する
void	setColorCode(String colorCode) チャンネルのカラーコードを設定する
void	setDescription(String description) チャンネルの説明文を設定する
void	setFormat(String format) チャンネルのメッセージフォーマットを設定する
void	setJapanizeType(JapanizeType japanize) Japanize変換設定を再設定する
void	setPassword(String password) チャンネルのパスワードを設定する
void	setPrivateMessageTo(String name) 1:1チャットのときに、会話の相手先を設定する
void	setVisible(boolean visible) チャンネルの可視性を設定する
void	setWorldRange(boolean isWorldRange) チャットを同ワールド内に制限するかどうかを設定する

クラス java.lang.Object から継承されたメソッド

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

メソッドの詳細

isPersonalChat

public boolean isPersonalChat()

1:1チャットかどうか

戻り値:

1:1チャットかどうか

isBroadcastChannel

public boolean isBroadcastChannel()

ブロードキャストチャンネルかどうか

戻り値:

ブロードキャストチャンネルかどうか

isGlobalChannel

public boolean isGlobalChannel()

グローバルチャンネルかどうか

戻り値:

グローバルチャンネルかどうか

isForceJoinChannel

public boolean isForceJoinChannel()

強制参加チャンネルかどうか

戻り値:

強制参加チャンネルかどうか

hasModeratorPermission

public boolean hasModeratorPermission(org.bukkit.command.CommandSender sender)

このチャンネルのモデレータ権限を持っているかどうかを確認する

パラメータ:

sender - 権限を確認する対象

戻り値:

チャンネルのモデレータ権限を持っているかどうか

chat

public abstract void chat(ChannelPlayer player,
                          String message)

このチャットに発言をする

パラメータ:

player - 発言をするプレイヤー

message - 発言をするメッセージ

chatFromOtherSource

public abstract void chatFromOtherSource(String player,
                                         String source,
                                         String message)

ほかの連携先などから、このチャットに発言する

パラメータ:

player - プレイヤー名

source - 連携元を判別する文字列

message - メッセージ

addMember

public void addMember(ChannelPlayer player)

メンバーを追加する

パラメータ:

name - 追加するプレイヤー

removeMember

public void removeMember(ChannelPlayer player)

メンバーを削除する

パラメータ:

name - 削除するプレイヤー

addModerator

public void addModerator(ChannelPlayer player)

モデレータを追加する

パラメータ:

player - 追加するプレイヤー

removeModerator

public void removeModerator(ChannelPlayer player)

モデレータを削除する

パラメータ:

player - 削除するプレイヤー

sendMessage

public abstract void sendMessage(ChannelPlayer player,
                                 String message,
                                 String format,
                                 boolean sendDynmap,
                                 String displayName)

メッセージを表示します。指定したプレイヤーの発言として処理されます。

パラメータ:

player - プレイヤー（ワールドチャット、範囲チャットの場合は必須です）

message - メッセージ

format - フォーマット

sendDynmap - dynmapへ送信するかどうか

displayName - 発言者の表示名（APIに使用されます）

getInfo

public abstract ArrayList<String> getInfo(boolean forModerator)

チャンネル情報を返す

パラメータ:

forModerator - モデレータ向けの情報を含めるかどうか

戻り値:

チャンネル情報

getLog

public abstract ArrayList<String> getLog(String player,
                                         String filter,
                                         String date,
                                         boolean reverse)

ログファイルを読み込んで、ログデータを取得する

パラメータ:

player - プレイヤー名、フィルタしないならnullを指定すること

filter - フィルタ、フィルタしないならnullを指定すること

date - 日付、今日のデータを取得するならnullを指定すること

reverse - 逆順取得

戻り値:

ログデータ

getOnlineNum

public int getOnlineNum()

チャンネルのオンライン人数を返す

戻り値:

オンライン人数

getTotalNum

public int getTotalNum()

チャンネルの総参加人数を返す

戻り値:

総参加人数

checkExpires

public abstract void checkExpires()

期限付きBanや期限付きMuteをチェックし、期限が切れていたら解除を行う

serialize

public Map<String,Object> serialize()

シリアライズ
ConfigurationSerializable互換のための実装。

定義:

インタフェース org.bukkit.configuration.serialization.ConfigurationSerializable 内の serialize

関連項目:

ConfigurationSerializable.serialize()

deserialize

public static Channel deserialize(Map<String,Object> data)

デシリアライズ
ConfigurationSerializable互換のための実装。

パラメータ:

data - デシリアライズ元のMapデータ。

戻り値:

デシリアライズされたクラス

getAlias

public String getAlias()

チャンネルの別名を返す

戻り値:

チャンネルの別名

setAlias

public void setAlias(String alias)

チャンネルの別名を設定する

パラメータ:

alias - チャンネルの別名

getDescription

public String getDescription()

チャンネルの説明文を返す

戻り値:

チャンネルの説明文

setDescription

public void setDescription(String description)

チャンネルの説明文を設定する

パラメータ:

description - チャンネルの説明文

getPassword

public String getPassword()

チャンネルのパスワードを返す

戻り値:

チャンネルのパスワード

setPassword

public void setPassword(String password)

チャンネルのパスワードを設定する

パラメータ:

password - チャンネルのパスワード

isVisible

public boolean isVisible()

チャンネルの可視性を返す

戻り値:

チャンネルの可視性

setVisible

public void setVisible(boolean visible)

チャンネルの可視性を設定する

パラメータ:

visible - チャンネルの可視性

getFormat

public String getFormat()

チャンネルのメッセージフォーマットを返す

戻り値:

チャンネルのメッセージフォーマット

setFormat

public void setFormat(String format)

チャンネルのメッセージフォーマットを設定する

パラメータ:

format - チャンネルのメッセージフォーマット

getMembers

public List<ChannelPlayer> getMembers()

チャンネルのメンバーを返す

戻り値:

チャンネルのメンバー

getModerator

public List<ChannelPlayer> getModerator()

チャンネルのモデレーターを返す

戻り値:

チャンネルのモデレーター

getBanned

public List<ChannelPlayer> getBanned()

チャンネルのBANリストを返す

戻り値:

チャンネルのBANリスト

getMuted

public List<ChannelPlayer> getMuted()

チャンネルのMuteリストを返す

戻り値:

チャンネルのMuteリスト

getBanExpires

public Map<ChannelPlayer,Long> getBanExpires()

期限付きBANの期限マップを返す（key=プレイヤー名、value=期日（ミリ秒））

戻り値:

banExpires

getMuteExpires

public Map<ChannelPlayer,Long> getMuteExpires()

期限付きMuteの期限マップを返す（key=プレイヤー名、value=期日（ミリ秒））

戻り値:

muteExpires

getHided

public List<ChannelPlayer> getHided()

非表示プレイヤーの一覧を返す

戻り値:

チャンネルの非表示プレイヤーの一覧

getName

public String getName()

チャンネル名を返す

戻り値:

チャンネル名

getColorCode

public String getColorCode()

チャンネルのカラーコードを返す

戻り値:

チャンネルのカラーコード

setColorCode

public void setColorCode(String colorCode)

チャンネルのカラーコードを設定する

パラメータ:

colorCode - カラーコード

setBroadcast

public void setBroadcast(boolean broadcast)

ブロードキャストチャンネルを設定する

パラメータ:

broadcast - ブロードキャストチャンネルにするかどうか

setWorldRange

public void setWorldRange(boolean isWorldRange)

チャットを同ワールド内に制限するかどうかを設定する

パラメータ:

isWorldRange - 同ワールド制限するかどうか

setChatRange

public void setChatRange(int range)

チャットの可聴範囲を設定する

パラメータ:

range - 可聴範囲

getPrivateMessageTo

public String getPrivateMessageTo()

1:1チャットのときに、会話の相手先を取得する

戻り値:

会話の相手のプレイヤー名

setPrivateMessageTo

public void setPrivateMessageTo(String name)

1:1チャットのときに、会話の相手先を設定する

パラメータ:

name - 会話の相手のプレイヤー名

isWorldRange

public boolean isWorldRange()

ワールドチャットかどうか

戻り値:

ワールドチャットかどうか

getChatRange

public int getChatRange()

チャットの可聴範囲、0の場合は無制限

戻り値:

チャットの可聴範囲

isAllowCC

public boolean isAllowCC()

カラーコードが使用可能な設定かどうか

戻り値:

allowccを返す

setAllowCC

public void setAllowCC(boolean allowcc)

カラーコードの使用可否を設定する

パラメータ:

allowcc - 使用可否

getJapanizeType

public JapanizeType getJapanizeType()

Japanize変換設定を取得する

戻り値:

japanize

setJapanizeType

public void setJapanizeType(JapanizeType japanize)

Japanize変換設定を再設定する

パラメータ:

japanize - japanize

save

public boolean save()

チャンネルの情報をファイルに保存する。

戻り値:

保存をしたかどうか。