diff options
| author | rubidium <rubidium@openttd.org> | 2011-12-15 18:40:15 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2011-12-15 18:40:15 +0000 |
| commit | 18d929aa21f42f292fd249e6d5feb6bf71ba93ae (patch) | |
| tree | 5a26d0c7d569a26381b3b3afa83afeac3e315763 /src/script/api/script_company.hpp | |
| parent | bb564bc34dd5db62d994eac10f88a81979a0f89c (diff) | |
| download | openttd-18d929aa21f42f292fd249e6d5feb6bf71ba93ae.tar.xz | |
(svn r23521) -Codechange: use the actual enum values from the 'core' in the API when they refer to the in-game values in the cases where that is possible and sensible
Diffstat (limited to 'src/script/api/script_company.hpp')
| -rw-r--r-- | src/script/api/script_company.hpp | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp index 051d3126a..428a1855c 100644 --- a/src/script/api/script_company.hpp +++ b/src/script/api/script_company.hpp @@ -22,16 +22,19 @@ class ScriptCompany : public ScriptObject { public: /** The range of possible quarters to get company information of. */ enum Quarter { - CURRENT_QUARTER = 0, ///< The current quarter. - EARLIEST_QUARTER = MAX_HISTORY_QUARTERS, ///< The earliest quarter company information is available for. + CURRENT_QUARTER = 0, ///< The current quarter. + EARLIEST_QUARTER = ::MAX_HISTORY_QUARTERS, ///< The earliest quarter company information is available for. }; /** Different constants related to CompanyID. */ enum CompanyID { - COMPANY_FIRST = 0, ///< The first available company. - COMPANY_LAST = ::MAX_COMPANIES, ///< The last available company. - COMPANY_SELF = 254, ///< Constant that gets resolved to the correct company index for your company. - COMPANY_INVALID = -1, ///< An invalid company. + /* Note: these values represent part of the in-game Owner enum */ + COMPANY_FIRST = ::COMPANY_FIRST, ///< The first available company. + COMPANY_LAST = ::MAX_COMPANIES, ///< The last available company. + + /* Custom added value, only valid for this API */ + COMPANY_INVALID = -1, ///< An invalid company. + COMPANY_SELF = 254, ///< Constant that gets resolved to the correct company index for your company. }; /** Possible genders for company presidents. */ |