nge::game::IPlayer Class Reference
#include <IPlayer.hpp>
Public Member Functions | |
| virtual E_LEVEL_NODE_TYPE | getType () const |
| Returns type of the level node. | |
| IPlayer (ICameraSceneNode *Camera, ILevelManager *lmgr, ISceneNode *SceneNode, f32 rotSpeed, f32 moveSpeed, bool verticalMovement, SOpKeyMap *keyMapArray, u32 keyMapSize, s32 id, c8 *name) | |
| Constructor. | |
| virtual bool | isInputReceiverEnabled () |
| Returns if the input receiver of the player is currently enabled. | |
| virtual bool | isKeyInputEnabled () |
| Returns if the the player receives key input. | |
| virtual bool | isMouseCursorUsed () const |
| Returns if the mouse cursor is locked to the center of the screen. | |
| virtual bool | isMouseInputEnabled () |
| Returns if the the player receives mouse input. | |
| virtual void | OnRegisterLevelNode () |
| This method is called just before the processing of the node. | |
| virtual void | setInputReceiverEnabled (bool enabled) |
| Disables or enables the player to get key or mouse inputs. | |
| virtual void | setKeyInputEnabled (bool enabled) |
| Disables or enables the player to get key input. | |
| virtual void | setMouseInputEnabled (bool enabled) |
| Disables or enables the player to get mouse input. | |
| virtual void | useMouseCursor (bool used) |
| Sets if the player will lock the mouse cursor to the center of the screen. | |
| virtual | ~IPlayer () |
| Destructor. | |
Protected Attributes | |
| ICameraSceneNode * | m_pCamera |
Detailed Description
Definition at line 16 of file IPlayer.hpp.
Constructor & Destructor Documentation
| nge::game::IPlayer::IPlayer | ( | ICameraSceneNode * | Camera, | |
| ILevelManager * | lmgr, | |||
| ISceneNode * | SceneNode, | |||
| f32 | rotSpeed, | |||
| f32 | moveSpeed, | |||
| bool | verticalMovement, | |||
| SOpKeyMap * | keyMapArray, | |||
| u32 | keyMapSize, | |||
| s32 | id, | |||
| c8 * | name | |||
| ) |
Constructor.
| virtual nge::game::IPlayer::~IPlayer | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual E_LEVEL_NODE_TYPE nge::game::IPlayer::getType | ( | ) | const [virtual] |
| virtual bool nge::game::IPlayer::isInputReceiverEnabled | ( | ) | [virtual] |
Returns if the input receiver of the player is currently enabled.
| virtual bool nge::game::IPlayer::isKeyInputEnabled | ( | ) | [virtual] |
Returns if the the player receives key input.
| virtual bool nge::game::IPlayer::isMouseCursorUsed | ( | ) | const [virtual] |
Returns if the mouse cursor is locked to the center of the screen.
| virtual bool nge::game::IPlayer::isMouseInputEnabled | ( | ) | [virtual] |
Returns if the the player receives mouse input.
| virtual void nge::game::IPlayer::OnRegisterLevelNode | ( | ) | [virtual] |
This method is called just before the processing of the node.
Nodes may register themselves in the process pipeline during this call, precalculate everything that should be processed, and prevent their children from being able to register themselves if they are idle by simply not calling their OnRegisterLevelNode() method. If you are implementing your own level node, you should override this method with an implementtion code looking like this:
if(!IsIdle) LevelManager->registerNodeForProcessing(this, pass); ILevelNode::OnRegisterLevelNode();
Reimplemented from nge::game::GameEntity.
| virtual void nge::game::IPlayer::setInputReceiverEnabled | ( | bool | enabled | ) | [virtual] |
Disables or enables the player to get key or mouse inputs.
| virtual void nge::game::IPlayer::setKeyInputEnabled | ( | bool | enabled | ) | [virtual] |
Disables or enables the player to get key input.
| virtual void nge::game::IPlayer::setMouseInputEnabled | ( | bool | enabled | ) | [virtual] |
Disables or enables the player to get mouse input.
| virtual void nge::game::IPlayer::useMouseCursor | ( | bool | used | ) | [virtual] |
Sets if the player will lock the mouse cursor to the center of the screen.
Member Data Documentation
ICameraSceneNode* nge::game::IPlayer::m_pCamera [protected] |
Definition at line 57 of file IPlayer.hpp.
The documentation for this class was generated from the following file:
