OpenTTD Source 20260621-master-g720d10536d
goal_type.h File Reference

Basic types related to goals. More...

#include "core/pool_type.hpp"

Go to the source code of this file.

Typedefs

using GoalQuestionButtons = EnumBitSet<GoalQuestionButton, uint32_t, GoalQuestionButton::End>
 Bitset of GoalQuestionButton elements.
typedef uint32_t GoalTypeID
 Contains either tile, industry ID, town ID, company ID, or story page ID.
using GoalID = PoolID<uint16_t, struct GoalIDTag, 64000, 0xFFFF>
 ID of a goal.

Enumerations

enum class  GoalQuestionType : uint8_t {
  Question = 0 , Information = 1 , Warning = 2 , Error = 3 ,
  End
}
 Types of goal questions. More...
enum class  GoalQuestionButton : uint8_t {
  Cancel , Ok , No , Yes ,
  Decline , Accept , Ignore , Retry ,
  Previous , Next , Stop , Start ,
  Go , Continue , Restart , Postpone ,
  Surrender , Close , End
}
 Types of buttons that can be in the question window. More...
enum class  GoalType : uint8_t {
  None , Tile , Industry , Town ,
  Company , StoryPage
}
 Types of goal destinations. More...

Detailed Description

Basic types related to goals.

Definition in file goal_type.h.

Typedef Documentation

◆ GoalID

using GoalID = PoolID<uint16_t, struct GoalIDTag, 64000, 0xFFFF>

ID of a goal.

Definition at line 63 of file goal_type.h.

◆ GoalQuestionButtons

Bitset of GoalQuestionButton elements.

Definition at line 48 of file goal_type.h.

◆ GoalTypeID

typedef uint32_t GoalTypeID

Contains either tile, industry ID, town ID, company ID, or story page ID.

Definition at line 60 of file goal_type.h.

Enumeration Type Documentation

◆ GoalQuestionButton

enum class GoalQuestionButton : uint8_t
strong

Types of buttons that can be in the question window.

Enumerator
Cancel 

Cancel button.

Ok 

OK button.

No 

No button.

Yes 

Yes button.

Decline 

Decline button.

Accept 

Accept button.

Ignore 

Ignore button.

Retry 

Retry button.

Previous 

Previous button.

Next 

Next button.

Stop 

Stop button.

Start 

Start button.

Go 

Go button.

Continue 

Continue button.

Restart 

Restart button.

Postpone 

Postpone button.

Surrender 

Surrender button.

Close 

Close button.

End 

End marker.

Definition at line 25 of file goal_type.h.

◆ GoalQuestionType

enum class GoalQuestionType : uint8_t
strong

Types of goal questions.

Enumerator
Question 

Asking a simple question; title: Question.

Information 

Showing an informational message; title: Information.

Warning 

Showing a warning; title: Warning.

Error 

Showing an error; title: Error.

End 

End marker.

Definition at line 16 of file goal_type.h.

◆ GoalType

enum class GoalType : uint8_t
strong

Types of goal destinations.

Enumerator
None 

Destination is not linked.

Tile 

Destination is a tile.

Industry 

Destination is an industry.

Town 

Destination is a town.

Company 

Destination is a company.

StoryPage 

Destination is a story page.

Definition at line 51 of file goal_type.h.