Struct about goals, current and completed. More...

#include <goal_base.h>

Inheritance diagram for Goal:

Public Member Functions
	Goal (GoalID index, GoalType type=GoalType::None, GoalTypeID dst=0, CompanyID company=CompanyID::Invalid(), const EncodedString &text={})
	Construct the goal.
	~Goal ()
	(Empty) destructor has to be defined else operator delete might be called with nullptr parameter

Static Public Member Functions
static bool	IsValidGoalDestination (CompanyID company, GoalType type, GoalTypeID dest)

Data Fields
CompanyID	company = CompanyID::Invalid()
	Goal is for a specific company; CompanyID::Invalid() if it is global.
GoalType	type = GoalType::None
	Type of the goal.
GoalTypeID	dst = 0
	Index of type.
EncodedString	text {}
	Text of the goal.
EncodedString	progress {}
	Progress text of the goal.
bool	completed = false
	Is the goal completed or not?

Detailed Description

Struct about goals, current and completed.

Definition at line 22 of file goal_base.h.

Constructor & Destructor Documentation

◆ Goal()

Goal::Goal	(	GoalID	index,
		GoalType	type = GoalType::None,
		GoalTypeID	dst = 0,
		CompanyID	company = CompanyID::Invalid(),
		const EncodedString &	text = {} )

inline

Construct the goal.

Parameters

index	The index within the goal pool.
type	The goal type.
dst	The goal target.
company	The company for the goal.
text	The text of the goal.

Definition at line 38 of file goal_base.h.

References company, dst, None, text, and type.

◆ ~Goal()

Goal::~Goal ( )

inline

(Empty) destructor has to be defined else operator delete might be called with nullptr parameter

Definition at line 44 of file goal_base.h.

Member Function Documentation

◆ IsValidGoalDestination()

bool Goal::IsValidGoalDestination	(	CompanyID	company,
		GoalType	type,
		GoalTypeID	dest )

static

Definition at line 34 of file goal.cpp.

Field Documentation

◆ company

CompanyID Goal::company = CompanyID::Invalid()

Goal is for a specific company; CompanyID::Invalid() if it is global.

Definition at line 23 of file goal_base.h.

Referenced by CmdCreateGoal(), CmdRemoveGoal(), CmdSetGoalCompleted(), CmdSetGoalDestination(), CmdSetGoalProgress(), CmdSetGoalText(), Goal(), and GoalListWindow::HandleClick().

◆ completed

bool Goal::completed = false

Is the goal completed or not?

Definition at line 28 of file goal_base.h.

Referenced by CmdSetGoalCompleted(), and StoryBookWindow::GetPageElementSprite().

◆ dst

GoalTypeID Goal::dst = 0

Index of type.

Definition at line 25 of file goal_base.h.

Referenced by CmdSetGoalDestination(), Goal(), and GoalListWindow::HandleClick().

◆ progress

EncodedString Goal::progress {}

Progress text of the goal.

Definition at line 27 of file goal_base.h.

Referenced by CmdSetGoalProgress().

◆ text

EncodedString Goal::text {}

Text of the goal.

Definition at line 26 of file goal_base.h.

Referenced by CmdSetGoalText(), StoryBookWindow::DrawWidget(), and Goal().

◆ type

GoalType Goal::type = GoalType::None

Type of the goal.

Definition at line 24 of file goal_base.h.