sys::Scoring Class Reference

Component that is responsible for managing the gameplay board, where cards are placed by Players. More...

#include <Scoring.h>

Inheritance diagram for sys::Scoring:

Collaboration diagram for sys::Scoring:

Public Member Functions
	Scoring ()
	~Scoring () override=default
	Scoring (const Scoring &other)=default
	Scoring (Scoring &&other) noexcept
auto	operator= (const Scoring &other) -> Scoring &
auto	operator= (Scoring &&other) noexcept -> Scoring &=default
auto	clone () const -> std::unique_ptr< GameObject > override
	makes a copy a GameObject even if it's held polymorphically
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	onUpdate (float dt) -> void override
	called once every frame.
auto	endWindow () -> void override
	currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
auto	onRender () -> void override
	called every frame after update has been called for every object.
auto	load (Stream &stream) -> void override
	Implementations will load the state of a GameObject from a th::Json Object.
auto	save (Stream &stream) const -> void override
	Implementations will load the state of a GameObject to a th::Json object.
auto	scoreBoard (Board &board, const std::vector< Card * > &cards) const -> int
	Checks all played cards and gets the hands.
Public Member Functions inherited from System
auto	showMenu () -> void override
	Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto	getKey () const -> Key override
	Generates a unique Key that corresponds to the GameObject.
auto	getParent () const -> GameObject *override
	Gets the parent of a GameObject.
Public Member Functions inherited from GameObject
	GameObject (std::string typeName, gobj::Type parentType, gobj::Type type)
	constructor for gameobject.
virtual	~GameObject ()
	destructor for GameObject.
	GameObject (const GameObject &other)
	Copy Constructor.
auto	operator= (const GameObject &other) -> GameObject &
	copy assignment operator
	GameObject (GameObject &&other) noexcept
	Move constructor.
auto	operator= (GameObject &&other) noexcept -> GameObject &
	Move assignment operator.
virtual auto	update (float dt) -> void
	called once every frame.
virtual auto	render () -> void
	called every frame after update has been called for every object.
virtual auto	destroy () -> void
	Marks an GameObject to be destroyed.
virtual auto	onEnterEngine () -> void
	hook that is called when a GameObject enters the Engine tree.
virtual auto	for_each (std::function< void(GameObject &)> func) -> void
	applies a function to every child.
virtual auto	for_each (std::function< void(const GameObject &)> func) const -> void
	applies a const function to every child.
virtual auto	parentTo (GameObject *newParent) -> bool
	Sets the GameObject as a child of another GameObject.
auto	getInternalParent () const -> GameObject *
	returns the actual owning parent of the GameObject
virtual auto	addChild (std::unique_ptr< GameObject > newChild) -> bool
	Adds a child to a GameObject.
auto	destroyed () const -> bool
auto	getUUID () const -> gobj::UUID
auto	isUUID (gobj::UUID compareUUID) const -> bool
auto	getName () const -> const std::string &
	Gets the type of the object as a string.
auto	getNickname () const -> const std::string &
	Gets the nickname (custom, writable name) of a GameObject.
void	calculateFormattedName () const
auto	getFormattedName () const -> const std::string &
	combines a GameObjects Type, Nickname, and UUID into one string, for use with logging.
auto	nameEquals (const std::string &compareString) const -> bool
	check whether a GameObjects typeName is equivilent to a given string.
auto	isType (gobj::Type otherType) const -> bool
	check whether the GameObject is the same as a given type.
auto	getObjectType () const -> gobj::Type
	gets the internal type of the GameObject, as an enum
auto	setNickname (const std::string &newNickname) -> void
	sets the GameObjects nickname.
auto	updates () const -> bool
auto	renders () const -> bool
auto	receivesMessages () const -> bool
auto	isActive () const -> bool
virtual auto	setShouldUpdate (const bool _shouldUpdate) -> void
	set whether the GameObject should update every frame, and whether all of it's children should update every frame
virtual auto	setShouldRender (const bool _shouldRender) -> void
	set whether the GameObject should render every frame, and whether all of it's children should render every frame
virtual auto	setShouldReceiveMessages (const bool _shouldReceiveMessages) -> void
	set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto	setActive (const bool shouldBeActive) -> void
	set the GameObject should update, render, and receive messages

Static Public Member Functions
static auto	getEnum () -> Type
	function required by all systems

Additional Inherited Members
Public Types inherited from System
enum class	Type : unsigned short {   system_error_type = 0 , newSystemStub = 100 , OpenGL = 200 , Input = 300 ,   Editor = 400 , Messaging = 500 , Camera = 600 , Logging = 700 ,   AudioSystem = 750 , Scoring = 800 , HandSystem = 900 , SceneManager = 1000 ,   ActionList = 1100 , DebugDraw = 1150 , TestRunner = 1200 , ColliderSystem = 1300 }
Public Attributes inherited from GameObject
friend	Entity
friend	Node
friend	ChildrenHandeler
friend	Engine
Protected Member Functions inherited from System
virtual auto	systemShowMenu () -> void
	Specific systems should override this function to show their specific menu for the system.
	System (const std::string &typeName, Type systemType)
Protected Member Functions inherited from GameObject
auto	setInternalParent (GameObject *parent) -> bool
	sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
auto	getGameObjectJson () const -> json
	Used for serializing GameObjects.
auto	setGameObjectJson (const json &stream) -> void
	used for deserializing GameObjects
virtual auto	getChildren () const -> std::shared_ptr< std::vector< GameObject * > >
	gets a vector of a GameObjects public (i.e.
auto	checkAddToSceneHook () -> void
	Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Detailed Description

Component that is responsible for managing the gameplay board, where cards are placed by Players.

@Board.h

Constructor & Destructor Documentation

Scoring() [1/3]

sys::Scoring::Scoring

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

~Scoring()

sys::Scoring::~Scoring ( )

overridedefault

Scoring() [2/3]

sys::Scoring::Scoring ( const Scoring & other )

default

Here is the call graph for this function:

Scoring() [3/3]

sys::Scoring::Scoring ( Scoring && other )

noexcept

Here is the call graph for this function:

Member Function Documentation

clone()

auto sys::Scoring::clone ( ) const->std::unique_ptr< GameObject >

inlineoverridevirtual

makes a copy a GameObject even if it's held polymorphically

Warning

When overriding this function, make sure to set the parents object to this

Returns

a unique_ptr to a new stack allocated object that is a copy of the object

Implements GameObject.

Here is the call graph for this function:

endWindow()

auto sys::Scoring::endWindow ( ) ->void

inlineoverridevirtual

currently unused, but intended to but was assumed to be necessary for a proper ImGui editor

Implements GameObject.

getEnum()

auto sys::Scoring::getEnum ( ) ->Type

inlinestatic

function required by all systems

load()

auto sys::Scoring::load ( Stream & stream ) ->void

overridevirtual

Implementations will load the state of a GameObject from a th::Json Object.

Unimplemented in GameObject

Parameters

stream

th::Json Object

Implements GameObject.

onRender()

auto sys::Scoring::onRender ( ) ->void

overridevirtual

called every frame after update has been called for every object.

Generally used for rendering an object to the screen, when applicable. Unimplemented in GameObject

Implements GameObject.

onUpdate()

auto sys::Scoring::onUpdate ( float dt ) ->void

overridevirtual

called once every frame.

Generally used for timers, movement, condition checks, etc. Unimplemented in GameObject

Parameters

dt	the time in seconds that has elapsed

Implements GameObject.

operator=() [1/2]

auto sys::Scoring::operator=

(

const Scoring &

other

)

->Scoring &

Here is the call graph for this function:

operator=() [2/2]

auto sys::Scoring::operator= ( Scoring && other ) ->Scoring &=default

defaultnoexcept

Here is the call graph for this function:

save()

auto sys::Scoring::save ( Stream & stream ) const->void

overridevirtual

Implementations will load the state of a GameObject to a th::Json object.

Unimplemented in GameObject

Parameters

stream

th::Json Object

Implements GameObject.

scoreBoard()

auto sys::Scoring::scoreBoard	(	Board &	board,
		const std::vector< Card * > &	cards ) const->int

Checks all played cards and gets the hands.

Parameters

board	The board to be scored
cards	The played cards stored in Table

Returns

The value of all scored hands

Here is the call graph for this function:

showMenu()

auto sys::Scoring::showMenu ( ) ->void

inlineoverridevirtual

Called before update each frame, for calling ImGui editor code relevant to the gameObject.

virtual because we might need to destroy other things too, like parent node for entity Has a empty definition in GameObject, so it may be overriden, but doesn't have to be.

Reimplemented from GameObject.

---

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

• /home/egrazil/sites/Brunot/The House/source/Gameplay/Systems/Scoring.h
• /home/egrazil/sites/Brunot/The House/source/Gameplay/Systems/Scoring.cpp