ChatMessage

public interface ChatMessage

チャットメッセージに対する操作を行うためのインターフェイスです。

Author:Jaken

Methods

addAfterMessage

public void addAfterMessage(String message)

チャットメッセージを追加します。 追加したメッセージは、処理中のメッセージが表示された後、順番に出力されます。 これは、ローカルチャットへ追加するだけで、サーバに送られることはありません。（利用者だけが見える） 注意：これを実現するためにチャットメッセージを横取りする必要があるので、他のチャット処理MODと競合する可能性があります。 このメソッドを使用するためには、 PluginInterface.onInitialize(PluginSettings) にて、あらかじめ PluginSettings.registerPermissionAddAfterMessage() を呼び出さなければなりません。

パラメタ:

• message – チャットメッセージ文字列

getMessage

public String getMessage()

チャットメッセージを取得します。 このプラグインが処理する前に、別のプラグインによって加工されている場合は、その内容が反映された状態で渡されます。 ※取得できるチャットメッセージにはユーザー名を含みません。 ※他のプラグインによって、チャットメッセージが削除されている場合、nullが返却される可能性があります。 このためnullチェックを必ず行ってください。

戻り値:チャットメッセージ文字列

getMessageOriginal

public String getMessageOriginal()

オリジナルのチャットメッセージを取得します。 他のプラグインの影響を受けずに、オリジナルのメッセージがほしい場合に使います。 ※取得できるチャットメッセージにはユーザー名を含みません。

戻り値:チャットメッセージ文字列

getOriginalJsonString

public String getOriginalJsonString()

オリジナルのJSONメッセージを取得します。 （Minecraft1.6以降でチャットメッセージの扱いが大きく変わっています）

戻り値:JSON形式の文字列

getUserName

public String getUserName()

発言したユーザー名を取得します。 メッセージがユーザーによる発言ではない場合はnullが返却されます。 （Minecraft1.6以降で確実にユーザー名が取得できるようになり、メッセージと分断可能になりました）

戻り値:ユーザー名の文字列

readStack

public Object readStack(String keyname)

スタックから指定のキー文字列に関連付けされているオブジェクトを取得します。 このメソッドを使うプラグインよりも前に、別のプラグインの ChatMessage.writeStack(String,Object) によって スタックにあらかじめ値が登録されている必要があります。 このメソッドを使用するためには、 PluginInterface.onInitialize(PluginSettings) にて、あらかじめ PluginSettings.registerPermissionReadStack(String) を呼び出さなければなりません。

パラメタ:

• keyname – スタックから受け取るキー文字列

戻り値:

キー文字列に登録されている値 ※null、文字列、数値、配列やクラスオブジェクトなどが受け取れます。

setMessage

public void setMessage(String message)

チャットメッセージを設定します。 ※nullをセットすると、チャットの発言自体を削除できますが、nullを想定していない他のチャット処理MODと競合する可能性があります。 このメソッドを使用するためには、 PluginInterface.onInitialize(PluginSettings) にて、あらかじめ PluginSettings.registerPermissionMessageModification() を呼び出さなければなりません。

パラメタ:

• message – チャットメッセージ文字列

writeStack

public void writeStack(String keyname, Object value)

スタックへ指定のキー文字列に関連付けした任意のオブジェクトをセットします。 任意のキー文字列を指定できます。 指定したキー文字列を知るプラグインは ChatMessage.readStack(String) にて値を受け取ることができます。 このメソッドを使用するためには、 PluginInterface.onInitialize(PluginSettings) にて、あらかじめ PluginSettings.registerPermissionWriteStack(String) を呼び出さなければなりません。

パラメタ:

• keyname – スタックに登録するキー文字列
• value – スタックに登録する値 ※null、文字列、数値、配列やクラスオブジェクトなども渡せます。