amdaemon::Player クラス

プレイヤーに紐付く情報をまとめて提供するMonostateクラス。 [詳解]

#include <Player.h>

公開メンバ関数
	Player (std::size_t index)
	コンストラクタ。 [詳解]
std::size_t	getIndex () const
	プレイヤーインデックスを取得する。 [詳解]
bool	beginPlay (const PlayBeginParam &param=PlayBeginParam())
	プレイ開始処理を行う。 [詳解]
bool	beginPlay (const PlayBeginParam &param, PlayErrorId &errorId)
	プレイ開始処理を行う。 [詳解]
bool	continuePlay (const PlayContinueParam &param=PlayContinueParam())
	コンティニュー処理を行う。 [詳解]
bool	continuePlay (const PlayContinueParam &param, PlayErrorId &errorId)
	コンティニュー処理を行う。 [詳解]
bool	endPlay (const PlayEndParam &param=PlayEndParam())
	プレイ終了処理を行う。 [詳解]
bool	endPlay (const PlayEndParam &param, PlayErrorId &errorId)
	プレイ終了処理を行う。 [詳解]
bool	isPlaying () const
	プレイ中であるか否かを取得する。 [詳解]
bool	isAccountingPlaying () const
	ALL.Net課金プレイ中であるか否かを取得する。 [詳解]
AimeId	getPlayingAimeId () const
	プレイ中のプレイヤーに紐付いているAimeのUID値を取得する。 [詳解]
const InputUnit &	getInputUnit () const
	ID付けされた入力情報インスタンスを取得する。 [詳解]
OutputUnit &	getOutputUnit ()
	ID付けされた出力情報インスタンスを取得する。 [詳解]
const OutputUnit &	getOutputUnit () const
	ID付けされた出力情報インスタンスを取得する。 [詳解]
CreditUnit &	getCreditUnit ()
	クレジット情報インスタンスを取得する。 [詳解]
const CreditUnit &	getCreditUnit () const
	クレジット情報インスタンスを取得する。 [詳解]
::amdaemon::allnet::AccountingUnit &	getAllnetAccountingUnit ()
	ALL.Net課金処理インスタンスを取得する。 [詳解]
const ::amdaemon::allnet::AccountingUnit &	getAllnetAccountingUnit () const
	ALL.Net課金処理インスタンスを取得する。 [詳解]

詳解

プレイヤーに紐付く情報をまとめて提供するMonostateクラス。

プレイヤーに紐付く各種インスタンスをひとまとめにしたクラス。 実際のインスタンスは Input クラスや Credit クラス等が保持している。

このクラス自体はプレイヤーインデックスしか保持していない。 そのためほとんどコスト無しでコピー可能である。

構築子と解体子

amdaemon::Player::Player ( std::size_t  index )

explicit

コンストラクタ。

引数

[in]

index

プレイヤーインデックス。

例外

Exception

引数 index に有効プレイヤー数以上の値を渡した場合。 有効プレイヤー数は Core クラスのメンバ関数 Core::getPlayerCount で取得できる。

関数詳解

std::size_t amdaemon::Player::getIndex ( ) const

inline

プレイヤーインデックスを取得する。

戻り値

プレイヤーインデックス。

bool amdaemon::Player::beginPlay

(

const PlayBeginParam &

param = PlayBeginParam()

)

プレイ開始処理を行う。

引数

[in]

param

プレイ開始処理パラメータ。

戻り値

true	成功した場合。
false	失敗した場合。

参照

Sequence::beginPlay(std::size_t, const PlayBeginParam&)

例外

Exception

プレイヤーが既にプレイ中である場合。 ゲームテストモード中である場合。 引数 param に不正な値を指定した場合。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

bool amdaemon::Player::beginPlay	(	const PlayBeginParam &	param,
		PlayErrorId &	errorId
	)

プレイ開始処理を行う。

引数

[in]	param	プレイ開始処理パラメータ。
[out]	errorId	処理失敗時のエラーID設定先。

戻り値

true	成功した場合。
false	失敗した場合。

参照

Sequence::beginPlay(std::size_t, const PlayBeginParam&, PlayErrorId&)

例外

Exception

プレイヤーが既にプレイ中である場合。 ゲームテストモード中である場合。 引数 param に不正な値を指定した場合。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

bool amdaemon::Player::continuePlay

(

const PlayContinueParam &

param = PlayContinueParam()

)

コンティニュー処理を行う。

引数

[in]

param

コンティニュー処理パラメータ。

戻り値

true	成功した場合。
false	失敗した場合。

参照

Sequence::continuePlay(std::size_t, const PlayContinueParam&)

例外

Exception

プレイヤーがプレイ中ではない場合。 ゲームテストモード中である場合。 引数 param に不正な値を指定した場合。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

bool amdaemon::Player::continuePlay	(	const PlayContinueParam &	param,
		PlayErrorId &	errorId
	)

コンティニュー処理を行う。

引数

[in]	param	コンティニュー処理パラメータ。
[out]	errorId	処理失敗時のエラーID設定先。

戻り値

true	成功した場合。
false	失敗した場合。

参照

Sequence::continuePlay(std::size_t, const PlayContinueParam&, PlayErrorId&)

例外

Exception

プレイヤーがプレイ中ではない場合。 ゲームテストモード中である場合。 引数 param に不正な値を指定した場合。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

bool amdaemon::Player::endPlay

(

const PlayEndParam &

param = PlayEndParam()

)

プレイ終了処理を行う。

引数

[in]

param

プレイ終了処理パラメータ。

戻り値

true	成功した場合。
false	失敗した場合。

参照

Sequence::endPlay(std::size_t, const PlayEndParam&)

例外

Exception

プレイヤーが既にプレイ中ではない場合。 ゲームテストモード中である場合。 引数 param に不正な値を指定した場合。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

bool amdaemon::Player::endPlay	(	const PlayEndParam &	param,
		PlayErrorId &	errorId
	)

プレイ終了処理を行う。

引数

[in]	param	プレイ終了処理パラメータ。
[out]	errorId	処理失敗時のエラーID設定先。

戻り値

true	成功した場合。
false	失敗した場合。

参照

Sequence::endPlay(std::size_t, const PlayEndParam&, PlayErrorId&)

例外

Exception

プレイヤーが既にプレイ中ではない場合。 ゲームテストモード中である場合。 引数 param に不正な値を指定した場合。

Daemonプロセスが処理完了するまで呼び出し元スレッドをブロックする。

bool amdaemon::Player::isPlaying

(

)

const

プレイ中であるか否かを取得する。

戻り値

true	プレイ中である場合。
false	プレイ中ではない場合。

参照

Sequence::isPlaying

bool amdaemon::Player::isAccountingPlaying

(

)

const

ALL.Net課金プレイ中であるか否かを取得する。

戻り値

true	ALL.Net課金プレイ中である場合。
false	ALL.Net課金プレイ中ではない場合。

参照

Sequence::isAccountingPlaying

Sequence クラスのメンバ関数 Sequence::getPlayAccountingTiming の戻り値が PlayAccountingTiming::Normal であり、なおかつメンバ関数 beginPlay や continuePlay でALL.Net課金プレイを開始済みである場合に true を返すようになる。

上記メンバ関数の戻り値が PlayAccountingTiming::Normal 以外である場合や、 AccountingUnit クラスのメンバ関数 AccountingUnit::beginPlay を直接呼び出して 課金プレイを開始した場合、この関数が true を返すことはない。

AimeId amdaemon::Player::getPlayingAimeId

(

)

const

プレイ中のプレイヤーに紐付いているAimeのUID値を取得する。

戻り値

AimeのUID値。紐付いていないかプレイ中でない場合は不正値。

参照

Sequence::getPlayingAimeId

const InputUnit& amdaemon::Player::getInputUnit

(

)

const

ID付けされた入力情報インスタンスを取得する。

戻り値

ID付けされた入力情報インスタンス。

参照

Input::getPlayer(std::size_t) const

OutputUnit& amdaemon::Player::getOutputUnit

(

)

ID付けされた出力情報インスタンスを取得する。

戻り値

ID付けされた出力情報インスタンス。

参照

Output::getPlayer(std::size_t)

const OutputUnit& amdaemon::Player::getOutputUnit

(

)

const

ID付けされた出力情報インスタンスを取得する。

戻り値

ID付けされた出力情報インスタンス。

参照

Output::getPlayer(std::size_t)

CreditUnit& amdaemon::Player::getCreditUnit

(

)

クレジット情報インスタンスを取得する。

戻り値

クレジット情報インスタンス。

参照

Credit::getPlayer(std::size_t)

const CreditUnit& amdaemon::Player::getCreditUnit

(

)

const

クレジット情報インスタンスを取得する。

戻り値

クレジット情報インスタンス。

参照

Credit::getPlayer(std::size_t)

::amdaemon::allnet::AccountingUnit& amdaemon::Player::getAllnetAccountingUnit

(

)

ALL.Net課金処理インスタンスを取得する。

戻り値

ALL.Net課金処理インスタンス。

参照

allnet::Accounting::getPlayer(std::size_t)

const ::amdaemon::allnet::AccountingUnit& amdaemon::Player::getAllnetAccountingUnit

(

)

const

ALL.Net課金処理インスタンスを取得する。

戻り値

ALL.Net課金処理インスタンス。

参照

allnet::Accounting::getPlayer(std::size_t)

---

このクラス詳解は次のファイルから抽出されました:

• Player.h