GSNews Class Reference

Class that handles news messages. More...


Public Types

enum  NewsType {
  NT_ECONOMY,
  NT_SUBSIDIES,
  NT_GENERAL
}
 Enumeration for the news types that a script can create news for. More...

Static Public Member Functions

static bool Create (NewsType type, Text *text, GSCompany::CompanyID company)
 Create a news messages for a company.


Detailed Description

Class that handles news messages.

Member Enumeration Documentation

Enumeration for the news types that a script can create news for.

Enumerator:
NT_ECONOMY  Category economy.
NT_SUBSIDIES  Category subsidies.
NT_GENERAL  Category general.


Member Function Documentation

static bool GSNews::Create ( NewsType  type,
Text *  text,
GSCompany::CompanyID  company 
) [static]

Create a news messages for a company.

Parameters:
type The type of the news.
text The text message to show (can be either a raw string, or a GSText object).
company The company, or COMPANY_INVALID for all companies.
Returns:
True if the action succeeded.
Precondition:
text != NULL.

company == COMPANY_INVALID || ResolveCompanyID(company) != COMPANY_INVALID.


Generated on Mon Sep 3 17:01:02 2012 for OpenTTD Game API by  doxygen 1.5.6