OpenTTD
Functions | Variables
goal.cpp File Reference

Handling of goals. More...

#include "stdafx.h"
#include "company_func.h"
#include "industry.h"
#include "town.h"
#include "window_func.h"
#include "goal_base.h"
#include "core/pool_func.hpp"
#include "game/game.hpp"
#include "command_func.h"
#include "company_base.h"
#include "story_base.h"
#include "string_func.h"
#include "gui.h"
#include "network/network.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

CommandCost CmdCreateGoal (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Create a new goal. More...
 
CommandCost CmdRemoveGoal (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Remove a goal. More...
 
CommandCost CmdSetGoalText (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Update goal text of a goal. More...
 
CommandCost CmdSetGoalProgress (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Update progress text of a goal. More...
 
CommandCost CmdSetGoalCompleted (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Update completed state of a goal. More...
 
CommandCost CmdGoalQuestion (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Ask a goal related question. More...
 
CommandCost CmdGoalQuestionAnswer (TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
 Reply to a goal question. More...
 

Variables

GoalID _new_goal_id
 
GoalPool _goal_pool ("Goal")
 

Detailed Description

Handling of goals.

Definition in file goal.cpp.

Function Documentation

◆ CmdCreateGoal()

CommandCost CmdCreateGoal ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Create a new goal.

Parameters
tileunused.
flagstype of operation
p1various bitstuffed elements
  • p1 = (bit 0 - 7) - GoalType of destination.
  • p1 = (bit 8 - 15) - Company for which this goal is.
p2GoalTypeID of destination.
textText of the goal.
Returns
the cost of this operation or an error

Definition at line 46 of file goal.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_goal_pool >::CanAllocateItem(), CMD_ERROR, and GB().

◆ CmdGoalQuestion()

CommandCost CmdGoalQuestion ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Ask a goal related question.

Parameters
tileunused.
flagstype of operation
p1various bitstuffed elements
  • p1 = (bit 0 - 15) - Unique ID to use for this question.
  • p1 = (bit 16 - 23) - Company for which this question is.
p2Buttons of the question.
textText of the question.
Returns
the cost of this operation or an error

Definition at line 242 of file goal.cpp.

References GB().

◆ CmdGoalQuestionAnswer()

CommandCost CmdGoalQuestionAnswer ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Reply to a goal question.

Parameters
tileunused.
flagstype of operation
p1Unique ID to use for this question.
p2Button the company pressed
textText of the question.
Returns
the cost of this operation or an error

Definition at line 271 of file goal.cpp.

◆ CmdRemoveGoal()

CommandCost CmdRemoveGoal ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

◆ CmdSetGoalCompleted()

CommandCost CmdSetGoalCompleted ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

Update completed state of a goal.

Parameters
tileunused.
flagstype of operation
p1GoalID to update.
p2completed state. If goal is completed, set to 1, otherwise 0.
textunused
Returns
the cost of this operation or an error

Definition at line 212 of file goal.cpp.

References _current_company, CMD_ERROR, Goal::company, Goal::completed, DC_EXEC, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_goal_pool >::Get(), INVALID_COMPANY, InvalidateWindowClassesData(), InvalidateWindowData(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_goal_pool >::IsValidID(), OWNER_DEITY, and WC_GOALS_LIST.

◆ CmdSetGoalProgress()

CommandCost CmdSetGoalProgress ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)

◆ CmdSetGoalText()

CommandCost CmdSetGoalText ( TileIndex  tile,
DoCommandFlag  flags,
uint32  p1,
uint32  p2,
const char *  text 
)