src/script/api/script_league.cpp

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file script_league.cpp Implementation of ScriptLeagueTable. */
   9
  10 #include "../../stdafx.h"
  11
  12 #include "script_league.hpp"
  13
  14 #include "../script_instance.hpp"
  15 #include "script_error.hpp"
  16 #include "../../league_base.h"
  17 #include "../../league_cmd.h"
  18
  19 #include "../../safeguards.h"
  20
  21
  22 /* static */ bool ScriptLeagueTable::IsValidLeagueTable(LeagueTableID table_id)
  23 {
  24         return ::LeagueTable::IsValidID(table_id);
  25 }
  26
  27 /* static */ ScriptLeagueTable::LeagueTableID ScriptLeagueTable::New(Text *title, Text *header, Text *footer)
  28 {
  29         ScriptObjectRef title_counter(title);
  30         ScriptObjectRef header_counter(header);
  31         ScriptObjectRef footer_counter(footer);
  32
  33         EnforceDeityMode(LEAGUE_TABLE_INVALID);
  34         EnforcePrecondition(LEAGUE_TABLE_INVALID, title != nullptr);
  35         std::string encoded_title = title->GetEncodedText();
  36         EnforcePreconditionEncodedText(LEAGUE_TABLE_INVALID, encoded_title);
  37
  38         std::string encoded_header = (header != nullptr ? header->GetEncodedText() : std::string{});
  39         std::string encoded_footer = (footer != nullptr ? footer->GetEncodedText() : std::string{});
  40
  41         if (!ScriptObject::Command<CMD_CREATE_LEAGUE_TABLE>::Do(&ScriptInstance::DoCommandReturnLeagueTableID, encoded_title, encoded_header, encoded_footer)) return LEAGUE_TABLE_INVALID;
  42
  43         /* In case of test-mode, we return LeagueTableID 0 */
  44         return (ScriptLeagueTable::LeagueTableID)0;
  45 }
  46
  47 /* static */ bool ScriptLeagueTable::IsValidLeagueTableElement(LeagueTableElementID element_id)
  48 {
  49         return ::LeagueTableElement::IsValidID(element_id);
  50 }
  51
  52 /* static */ ScriptLeagueTable::LeagueTableElementID ScriptLeagueTable::NewElement(ScriptLeagueTable::LeagueTableID table, SQInteger rating, ScriptCompany::CompanyID company, Text *text, Text *score, LinkType link_type, SQInteger link_target)
  53 {
  54         ScriptObjectRef text_counter(text);
  55         ScriptObjectRef score_counter(score);
  56
  57         EnforceDeityMode(LEAGUE_TABLE_ELEMENT_INVALID);
  58
  59         EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, IsValidLeagueTable(table));
  60
  61         EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, company == ScriptCompany::COMPANY_INVALID || ScriptCompany::ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID);
  62         CompanyID c = (::CompanyID)company;
  63         if (company == ScriptCompany::COMPANY_INVALID) c = INVALID_COMPANY;
  64
  65         EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, text != nullptr);
  66         std::string encoded_text = text->GetEncodedText();
  67         EnforcePreconditionEncodedText(LEAGUE_TABLE_ELEMENT_INVALID, encoded_text);
  68
  69         EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, score != nullptr);
  70         std::string encoded_score = score->GetEncodedText();
  71         EnforcePreconditionEncodedText(LEAGUE_TABLE_ELEMENT_INVALID, encoded_score);
  72
  73         EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, IsValidLink(Link((::LinkType)link_type, link_target)));
  74
  75         if (!ScriptObject::Command<CMD_CREATE_LEAGUE_TABLE_ELEMENT>::Do(&ScriptInstance::DoCommandReturnLeagueTableElementID, table, rating, c, encoded_text, encoded_score, (::LinkType)link_type, (::LinkTargetID)link_target)) return LEAGUE_TABLE_ELEMENT_INVALID;
  76
  77         /* In case of test-mode, we return LeagueTableElementID 0 */
  78         return (ScriptLeagueTable::LeagueTableElementID)0;
  79 }
  80
  81 /* static */ bool ScriptLeagueTable::UpdateElementData(LeagueTableElementID element, ScriptCompany::CompanyID company, Text *text, LinkType link_type, SQInteger link_target)
  82 {
  83         ScriptObjectRef text_counter(text);
  84
  85         EnforceDeityMode(false);
  86         EnforcePrecondition(false, IsValidLeagueTableElement(element));
  87
  88         EnforcePrecondition(false, company == ScriptCompany::COMPANY_INVALID || ScriptCompany::ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID);
  89         CompanyID c = (::CompanyID)company;
  90         if (company == ScriptCompany::COMPANY_INVALID) c = INVALID_COMPANY;
  91
  92         EnforcePrecondition(false, text != nullptr);
  93         std::string encoded_text = text->GetEncodedText();
  94         EnforcePreconditionEncodedText(false, encoded_text);
  95
  96         EnforcePrecondition(false, IsValidLink(Link((::LinkType)link_type, link_target)));
  97
  98         return ScriptObject::Command<CMD_UPDATE_LEAGUE_TABLE_ELEMENT_DATA>::Do(element, c, encoded_text, (::LinkType)link_type, (::LinkTargetID)link_target);
  99 }
 100
 101 /* static */ bool ScriptLeagueTable::UpdateElementScore(LeagueTableElementID element, SQInteger rating, Text *score)
 102 {
 103         ScriptObjectRef score_counter(score);
 104
 105         EnforceDeityMode(false);
 106         EnforcePrecondition(false, IsValidLeagueTableElement(element));
 107
 108         EnforcePrecondition(false, score != nullptr);
 109         std::string encoded_score = score->GetEncodedText();
 110         EnforcePreconditionEncodedText(false, encoded_score);
 111
 112         return ScriptObject::Command<CMD_UPDATE_LEAGUE_TABLE_ELEMENT_SCORE>::Do(element, rating, encoded_score);
 113 }
 114
 115 /* static */ bool ScriptLeagueTable::RemoveElement(LeagueTableElementID element)
 116 {
 117         EnforceDeityMode(false);
 118         EnforcePrecondition(false, IsValidLeagueTableElement(element));
 119
 120         return ScriptObject::Command<CMD_REMOVE_LEAGUE_TABLE_ELEMENT>::Do(element);
 121 }