PlatformDataEngine::CharacterController Class Reference

A component that handles player input and animations (if enabled) Precondition: if animations are enabled, the gameObject must have an animation controller component More...

#include <CharacterController.h>

Inheritance diagram for PlatformDataEngine::CharacterController:

Public Member Functions
void	init ()
	Called once on startup More...
void	update (const float &dt, const float &elapsedTime)
	Called every update cycle More...
void	draw (sf::RenderTarget &target, sf::RenderStates states) const
	Called every draw cycle More...
void	copy (std::shared_ptr< Component > otherCompPtr)
	Essentially a copy constructor except the generic shared pointer must be converted to the derived type using std::dynamic_pointer_cast More...
void	loadDefinition (nlohmann::json object)
	Called when game object definitions are loaded More...
DirTestMask	isAdjacentWall () const
	Checks if the character is adjacent to the ground or some other solid object More...
bool	fastGroundCheck () const
	Use this if you don't need to know the direction the player is contacting the ground More...
InputManager *	getInputManager () const
Public Member Functions inherited from PlatformDataEngine::Component
virtual void	copy (std::shared_ptr< Component > otherCompPtr)
	Essentially a copy constructor except the generic shared pointer must be converted to the derived type using std::dynamic_pointer_cast More...
void	registerHierarchy (GameObject *parent)
virtual void	init ()
	Called once on startup More...
virtual void	update (const float &dt, const float &elapsedTime)
	Called every update cycle More...
virtual void	draw (sf::RenderTarget &target, sf::RenderStates states) const
	Called every draw cycle More...
virtual void	networkSerializeInit (PDEPacket &output)
	Called when sending data for the first time More...
virtual void	networkDeserializeInit (PDEPacket &input)
	Called when recieving data for the first time More...
virtual void	networkSerialize (PDEPacket &output)
	Use this function to serialize any members you want replicated this is handy for animation components that should copy their state to all client instances More...
virtual void	networkDeserialize (PDEPacket &input)
	Use this function to deserialize data coming from the server for this specific client More...
virtual void	loadDefinition (nlohmann::json object)
	Called when game object definitions are loaded More...
std::string	getType () const
nlohmann::json	getProps () const
void	setType (const std::string &type)
void	setProps (nlohmann::json &props)
void	setIsDefinition (bool isDef)
virtual void	networkSerializeInit (PDEPacket &output)=0
	Called when an object is sent to the clients for the first time More...
virtual void	networkDeserializeInit (PDEPacket &input)=0
	Called when an object is recieved on a client for the first time More...
virtual void	networkSerialize (PDEPacket &output)=0
	Called every time an object is sent to a client More...
virtual void	networkDeserialize (PDEPacket &input)=0
	Called every time an object is recieved from a client More...

Static Public Member Functions
static bool	HasFlag (int a, int b)

Additional Inherited Members
Protected Attributes inherited from PlatformDataEngine::Component
std::map< std::string, nlohmann::json >	m_properties
GameObject *	m_parent
bool	m_isDefinition
nlohmann::json	m_all_props
std::string	m_type

Detailed Description

A component that handles player input and animations (if enabled) Precondition: if animations are enabled, the gameObject must have an animation controller component

Member Function Documentation

copy()

void CharacterController::copy ( std::shared_ptr< Component >  otherCompPtr )

virtual

Essentially a copy constructor except the generic shared pointer must be converted to the derived type using std::dynamic_pointer_cast

Parameters

otherCompPtr

Reimplemented from PlatformDataEngine::Component.

draw()

void CharacterController::draw ( sf::RenderTarget &  target, sf::RenderStates  states  ) const

virtual

Called every draw cycle

Parameters

target
states

Reimplemented from PlatformDataEngine::Component.

fastGroundCheck()

bool CharacterController::fastGroundCheck

(

)

const

Use this if you don't need to know the direction the player is contacting the ground

Returns

init()

void CharacterController::init ( )

virtual

Called once on startup

Reimplemented from PlatformDataEngine::Component.

isAdjacentWall()

DirTestMask CharacterController::isAdjacentWall

(

)

const

Checks if the character is adjacent to the ground or some other solid object

Returns

loadDefinition()

void CharacterController::loadDefinition ( nlohmann::json  object )

virtual

Called when game object definitions are loaded

Parameters

object

Reimplemented from PlatformDataEngine::Component.

update()

void CharacterController::update ( const float &  dt, const float &  elapsedTime  )

virtual

Called every update cycle

Parameters

dt	delta time
elapsedTime	elapsed time

Reimplemented from PlatformDataEngine::Component.

---

The documentation for this class was generated from the following files:

• PlatformDataEngine/CharacterController.h
• PlatformDataEngine/CharacterController.cpp