AM Daemon ライブラリリファレンス
公開メンバ関数 | 全メンバ一覧

ID付けされた入力情報を提供するMonostateクラス。 [詳解]

#include <Input.h>

公開メンバ関数

const InputUnitgetSystem () const
 システムの入力情報インスタンスを取得する。 [詳解]
 
std::size_t getPlayerCount () const
 有効プレイヤー数を取得する。 [詳解]
 
const InputUnitgetPlayer (std::size_t playerIndex) const
 プレイヤーの入力情報インスタンスを取得する。 [詳解]
 
std::vector< std::reference_wrapper< const InputUnit > > getPlayers () const
 プレイヤーの入力情報インスタンス配列を取得する。 [詳解]
 

詳解

ID付けされた入力情報を提供するMonostateクラス。

Core クラスのメンバ関数 Core::execute 呼び出しによって内容が更新される。

このクラスを利用するためには Daemonプロセスの設定ファイルに入力識別ID等の定義を行う必要がある。

関数詳解

const InputUnit& amdaemon::Input::getSystem ( ) const

システムの入力情報インスタンスを取得する。

戻り値
システムの入力情報インスタンス。

TESTボタン等、プレイヤーに紐付かない入力がカテゴライズされる。

std::size_t amdaemon::Input::getPlayerCount ( ) const

有効プレイヤー数を取得する。

戻り値
有効プレイヤー数。
参照
Core::getPlayerCount

Core::getPlayerCount と同じ値を返す。

const InputUnit& amdaemon::Input::getPlayer ( std::size_t  playerIndex) const

プレイヤーの入力情報インスタンスを取得する。

引数
[in]playerIndexプレイヤーインデックス。
戻り値
プレイヤーの入力情報インスタンス。
参照
Player
例外
Exception引数 playerIndex に有効プレイヤー数以上の値を指定した場合。 有効プレイヤー数はメンバ関数 getPlayerCount で取得できる。
std::vector<std::reference_wrapper<const InputUnit> > amdaemon::Input::getPlayers ( ) const
inline

プレイヤーの入力情報インスタンス配列を取得する。

戻り値
プレイヤーの入力情報インスタンス配列。

範囲for文や各種アルゴリズム関数に渡すことを想定している。

  • 有効プレイヤー数を知りたいだけならばメンバ関数 getPlayerCount を用いること。
  • 特定プレイヤーの情報を取得したいだけならばメンバ関数 getPlayer を用いること。

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