File diff r26611:c20052f554e0 → r26612:e1c0fa463732
src/script/api/script_league.cpp
Show inline comments
 
new file 100644
 
/*
 
 * This file is part of OpenTTD.
 
 * 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.
 
 * 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.
 
 * 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/>.
 
 */
 

	
 
/** @file script_league.cpp Implementation of ScriptLeagueTable. */
 

	
 
#include "../../stdafx.h"
 

	
 
#include "script_league.hpp"
 

	
 
#include "../script_instance.hpp"
 
#include "script_error.hpp"
 
#include "../../league_base.h"
 
#include "../../league_cmd.h"
 

	
 
#include "../../safeguards.h"
 

	
 

	
 
/* static */ bool ScriptLeagueTable::IsValidLeagueTable(LeagueTableID table_id)
 
{
 
	return ::LeagueTable::IsValidID(table_id);
 
}
 

	
 
/* static */ ScriptLeagueTable::LeagueTableID ScriptLeagueTable::New(Text *title, Text *header, Text *footer)
 
{
 
	CCountedPtr<Text> title_counter(title);
 
	CCountedPtr<Text> header_counter(header);
 
	CCountedPtr<Text> footer_counter(footer);
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_INVALID, ScriptObject::GetCompany() == OWNER_DEITY);
 
	EnforcePrecondition(LEAGUE_TABLE_INVALID, title != nullptr);
 
	const char *encoded_title = title->GetEncodedText();
 
	EnforcePreconditionEncodedText(LEAGUE_TABLE_INVALID, encoded_title);
 

	
 
	auto encoded_header = (header != nullptr ? std::string{ header->GetEncodedText() } : std::string{});
 
	auto encoded_footer = (footer != nullptr ? std::string{ footer->GetEncodedText() } : std::string{});
 

	
 
	if (!ScriptObject::Command<CMD_CREATE_LEAGUE_TABLE>::Do(&ScriptInstance::DoCommandReturnLeagueTableID, encoded_title, encoded_header, encoded_footer)) return LEAGUE_TABLE_INVALID;
 

	
 
	/* In case of test-mode, we return LeagueTableID 0 */
 
	return (ScriptLeagueTable::LeagueTableID)0;
 
}
 

	
 
/* static */ bool ScriptLeagueTable::IsValidLeagueTableElement(LeagueTableElementID element_id)
 
{
 
	return ::LeagueTableElement::IsValidID(element_id);
 
}
 

	
 
/* static */ ScriptLeagueTable::LeagueTableElementID ScriptLeagueTable::NewElement(ScriptLeagueTable::LeagueTableID table, int64 rating, ScriptCompany::CompanyID company, Text *text, Text *score, LinkType link_type, uint32 link_target)
 
{
 
	CCountedPtr<Text> text_counter(text);
 
	CCountedPtr<Text> score_counter(score);
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, ScriptObject::GetCompany() == OWNER_DEITY);
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, IsValidLeagueTable(table));
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, company == ScriptCompany::COMPANY_INVALID || ScriptCompany::ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID);
 
	CompanyID c = (::CompanyID)company;
 
	if (company == ScriptCompany::COMPANY_INVALID) c = INVALID_COMPANY;
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, text != nullptr);
 
	const char *encoded_text_ptr = text->GetEncodedText();
 
	EnforcePreconditionEncodedText(LEAGUE_TABLE_ELEMENT_INVALID, encoded_text_ptr);
 
	std::string encoded_text = encoded_text_ptr;  // save into string so GetEncodedText can reuse the internal buffer
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, score != nullptr);
 
	const char *encoded_score = score->GetEncodedText();
 
	EnforcePreconditionEncodedText(LEAGUE_TABLE_ELEMENT_INVALID, encoded_score);
 

	
 
	EnforcePrecondition(LEAGUE_TABLE_ELEMENT_INVALID, IsValidLink(Link((::LinkType)link_type, link_target)));
 

	
 
	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;
 

	
 
	/* In case of test-mode, we return LeagueTableElementID 0 */
 
	return (ScriptLeagueTable::LeagueTableElementID)0;
 
}
 

	
 
/* static */ bool ScriptLeagueTable::UpdateElementData(LeagueTableElementID element, ScriptCompany::CompanyID company, Text *text, LinkType link_type, LinkTargetID link_target)
 
{
 
	CCountedPtr<Text> text_counter(text);
 

	
 
	EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
 
	EnforcePrecondition(false, IsValidLeagueTableElement(element));
 

	
 
	EnforcePrecondition(false, company == ScriptCompany::COMPANY_INVALID || ScriptCompany::ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID);
 
	CompanyID c = (::CompanyID)company;
 
	if (company == ScriptCompany::COMPANY_INVALID) c = INVALID_COMPANY;
 

	
 
	EnforcePrecondition(false, text != nullptr);
 
	const char *encoded_text = text->GetEncodedText();
 
	EnforcePreconditionEncodedText(false, encoded_text);
 

	
 
	EnforcePrecondition(false, IsValidLink(Link((::LinkType)link_type, link_target)));
 

	
 
	return ScriptObject::Command<CMD_UPDATE_LEAGUE_TABLE_ELEMENT_DATA>::Do(element, c, encoded_text, (::LinkType)link_type, (::LinkTargetID)link_target);
 
}
 

	
 
/* static */ bool ScriptLeagueTable::UpdateElementScore(LeagueTableElementID element, int64 rating, Text *score)
 
{
 
	CCountedPtr<Text> score_counter(score);
 

	
 
	EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
 
	EnforcePrecondition(false, IsValidLeagueTableElement(element));
 

	
 
	EnforcePrecondition(false, score != nullptr);
 
	const char *encoded_score = score->GetEncodedText();
 
	EnforcePreconditionEncodedText(false, encoded_score);
 

	
 
	return ScriptObject::Command<CMD_UPDATE_LEAGUE_TABLE_ELEMENT_SCORE>::Do(element, rating, encoded_score);
 
}
 

	
 
/* static */ bool ScriptLeagueTable::RemoveElement(LeagueTableElementID element)
 
{
 
	EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
 
	EnforcePrecondition(false, IsValidLeagueTableElement(element));
 

	
 
	return ScriptObject::Command<CMD_REMOVE_LEAGUE_TABLE_ELEMENT>::Do(element);
 
}