Files
@ r26684:bd3e30073232
Branch filter:
Location: cpp/openttd-patchpack/source/src/script/api/script_story_page.cpp - annotation
r26684:bd3e30073232
9.7 KiB
text/x-c
Add: Additional vehicle flags to control variants.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r26105:23588534dec9 r20329:0b11d054e50d r21383:942c32fb8b0e r21383:942c32fb8b0e r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r26105:23588534dec9 r26117:dec8ad7628ec r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r24220:eba5f923a47c r24220:eba5f923a47c r20329:0b11d054e50d r20329:0b11d054e50d r24220:eba5f923a47c r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24224:45d627b50749 r24224:45d627b50749 r24224:45d627b50749 r24224:45d627b50749 r24220:eba5f923a47c r24220:eba5f923a47c r26105:23588534dec9 r26105:23588534dec9 r26117:dec8ad7628ec r24220:eba5f923a47c r26105:23588534dec9 r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r24220:eba5f923a47c r20368:8351bea887fd r20368:8351bea887fd r20368:8351bea887fd r20329:0b11d054e50d r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24286:92a5312e02d8 r24220:eba5f923a47c r24220:eba5f923a47c r24286:92a5312e02d8 r24286:92a5312e02d8 r24286:92a5312e02d8 r24286:92a5312e02d8 r24220:eba5f923a47c r24220:eba5f923a47c r24286:92a5312e02d8 r24224:45d627b50749 r24224:45d627b50749 r24224:45d627b50749 r24220:eba5f923a47c r24220:eba5f923a47c r26105:23588534dec9 r20498:aad2dee6d212 r24220:eba5f923a47c r26105:23588534dec9 r20329:0b11d054e50d r20329:0b11d054e50d r21218:8daf27729482 r21215:9db6a30bdb18 r21215:9db6a30bdb18 r21215:9db6a30bdb18 r21215:9db6a30bdb18 r21215:9db6a30bdb18 r21215:9db6a30bdb18 r21218:8daf27729482 r21217:433ac9b65f88 r21217:433ac9b65f88 r21217:433ac9b65f88 r21217:433ac9b65f88 r21217:433ac9b65f88 r21217:433ac9b65f88 r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r26117:dec8ad7628ec r20329:0b11d054e50d r20329:0b11d054e50d r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21219:7180bb39d4d9 r21218:8daf27729482 r21219:7180bb39d4d9 r21219:7180bb39d4d9 r21218:8daf27729482 r21219:7180bb39d4d9 r21218:8daf27729482 r21218:8daf27729482 r21219:7180bb39d4d9 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r26117:dec8ad7628ec r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r20339:ff8e383cfb7d r20339:ff8e383cfb7d r20339:ff8e383cfb7d r20339:ff8e383cfb7d r20339:ff8e383cfb7d r26117:dec8ad7628ec r20339:ff8e383cfb7d r20339:ff8e383cfb7d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r20329:0b11d054e50d r26117:dec8ad7628ec r20329:0b11d054e50d r20329:0b11d054e50d r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r21218:8daf27729482 r26117:dec8ad7628ec r21218:8daf27729482 r21218:8daf27729482 r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c r24220:eba5f923a47c | /*
* 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_story_page.cpp Implementation of ScriptStoryPage. */
#include "../../stdafx.h"
#include "script_story_page.hpp"
#include "script_error.hpp"
#include "script_industry.hpp"
#include "script_map.hpp"
#include "script_town.hpp"
#include "script_goal.hpp"
#include "../script_instance.hpp"
#include "../../story_base.h"
#include "../../goal_base.h"
#include "../../string_func.h"
#include "../../tile_map.h"
#include "../../story_cmd.h"
#include "../../safeguards.h"
static inline bool StoryPageElementTypeRequiresText(StoryPageElementType type)
{
return type == SPET_TEXT || type == SPET_LOCATION || type == SPET_BUTTON_PUSH || type == SPET_BUTTON_TILE || type == SPET_BUTTON_VEHICLE;
}
/* static */ bool ScriptStoryPage::IsValidStoryPage(StoryPageID story_page_id)
{
return ::StoryPage::IsValidID(story_page_id);
}
/* static */ bool ScriptStoryPage::IsValidStoryPageElement(StoryPageElementID story_page_element_id)
{
return ::StoryPageElement::IsValidID(story_page_element_id);
}
/* static */ ScriptStoryPage::StoryPageID ScriptStoryPage::New(ScriptCompany::CompanyID company, Text *title)
{
CCountedPtr<Text> counter(title);
EnforcePrecondition(STORY_PAGE_INVALID, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(STORY_PAGE_INVALID, company == ScriptCompany::COMPANY_INVALID || ScriptCompany::ResolveCompanyID(company) != ScriptCompany::COMPANY_INVALID);
uint8 c = company;
if (company == ScriptCompany::COMPANY_INVALID) c = INVALID_COMPANY;
if (!ScriptObject::Command<CMD_CREATE_STORY_PAGE>::Do(&ScriptInstance::DoCommandReturnStoryPageID,
(::CompanyID)c, title != nullptr ? std::string{ title->GetEncodedText() } : std::string{})) return STORY_PAGE_INVALID;
/* In case of test-mode, we return StoryPageID 0 */
return (ScriptStoryPage::StoryPageID)0;
}
/* static */ ScriptStoryPage::StoryPageElementID ScriptStoryPage::NewElement(StoryPageID story_page_id, StoryPageElementType type, uint32 reference, Text *text)
{
CCountedPtr<Text> counter(text);
::StoryPageElementType btype = static_cast<::StoryPageElementType>(type);
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, IsValidStoryPage(story_page_id));
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, !StoryPageElementTypeRequiresText(btype) || (text != nullptr && !StrEmpty(text->GetEncodedText())));
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, type != SPET_LOCATION || ::IsValidTile(reference));
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, type != SPET_GOAL || ScriptGoal::IsValidGoal((ScriptGoal::GoalID)reference));
EnforcePrecondition(STORY_PAGE_ELEMENT_INVALID, type != SPET_GOAL || !(StoryPage::Get(story_page_id)->company == INVALID_COMPANY && Goal::Get(reference)->company != INVALID_COMPANY));
uint32 refid = 0;
TileIndex reftile = 0;
switch (type) {
case SPET_LOCATION:
reftile = reference;
break;
case SPET_GOAL:
case SPET_BUTTON_PUSH:
case SPET_BUTTON_TILE:
case SPET_BUTTON_VEHICLE:
refid = reference;
break;
case SPET_TEXT:
break;
default:
NOT_REACHED();
}
if (!ScriptObject::Command<CMD_CREATE_STORY_PAGE_ELEMENT>::Do(&ScriptInstance::DoCommandReturnStoryPageElementID,
reftile,
(::StoryPageID)story_page_id, (::StoryPageElementType)type,
refid,
StoryPageElementTypeRequiresText(btype) ? std::string{ text->GetEncodedText() } : std::string{})) return STORY_PAGE_ELEMENT_INVALID;
/* In case of test-mode, we return StoryPageElementID 0 */
return (ScriptStoryPage::StoryPageElementID)0;
}
/* static */ bool ScriptStoryPage::UpdateElement(StoryPageElementID story_page_element_id, uint32 reference, Text *text)
{
CCountedPtr<Text> counter(text);
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(false, IsValidStoryPageElement(story_page_element_id));
StoryPageElement *pe = StoryPageElement::Get(story_page_element_id);
StoryPage *p = StoryPage::Get(pe->page);
::StoryPageElementType type = pe->type;
EnforcePrecondition(false, !StoryPageElementTypeRequiresText(type) || (text != nullptr && !StrEmpty(text->GetEncodedText())));
EnforcePrecondition(false, type != ::SPET_LOCATION || ::IsValidTile(reference));
EnforcePrecondition(false, type != ::SPET_GOAL || ScriptGoal::IsValidGoal((ScriptGoal::GoalID)reference));
EnforcePrecondition(false, type != ::SPET_GOAL || !(p->company == INVALID_COMPANY && Goal::Get(reference)->company != INVALID_COMPANY));
uint32 refid = 0;
TileIndex reftile = 0;
switch (type) {
case ::SPET_LOCATION:
reftile = reference;
break;
case ::SPET_GOAL:
case ::SPET_BUTTON_PUSH:
case ::SPET_BUTTON_TILE:
case ::SPET_BUTTON_VEHICLE:
refid = reference;
break;
case ::SPET_TEXT:
break;
default:
NOT_REACHED();
}
return ScriptObject::Command<CMD_UPDATE_STORY_PAGE_ELEMENT>::Do(reftile,
story_page_element_id,
refid,
StoryPageElementTypeRequiresText(type) ? std::string{ text->GetEncodedText() } : std::string{});
}
/* static */ uint32 ScriptStoryPage::GetPageSortValue(StoryPageID story_page_id)
{
EnforcePrecondition(false, IsValidStoryPage(story_page_id));
return StoryPage::Get(story_page_id)->sort_value;
}
/* static */ uint32 ScriptStoryPage::GetPageElementSortValue(StoryPageElementID story_page_element_id)
{
EnforcePrecondition(false, IsValidStoryPageElement(story_page_element_id));
return StoryPageElement::Get(story_page_element_id)->sort_value;
}
/* static */ bool ScriptStoryPage::SetTitle(StoryPageID story_page_id, Text *title)
{
CCountedPtr<Text> counter(title);
EnforcePrecondition(false, IsValidStoryPage(story_page_id));
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
return ScriptObject::Command<CMD_SET_STORY_PAGE_TITLE>::Do(story_page_id, title != nullptr ? std::string{ title->GetEncodedText() } : std::string{});
}
/* static */ ScriptCompany::CompanyID ScriptStoryPage::GetCompany(StoryPageID story_page_id)
{
EnforcePrecondition(ScriptCompany::COMPANY_INVALID, IsValidStoryPage(story_page_id));
CompanyID c = StoryPage::Get(story_page_id)->company;
ScriptCompany::CompanyID company = c == INVALID_COMPANY ? ScriptCompany::COMPANY_INVALID : (ScriptCompany::CompanyID)c;
return company;
}
/* static */ ScriptDate::Date ScriptStoryPage::GetDate(StoryPageID story_page_id)
{
EnforcePrecondition(ScriptDate::DATE_INVALID, IsValidStoryPage(story_page_id));
EnforcePrecondition(ScriptDate::DATE_INVALID, ScriptObject::GetCompany() == OWNER_DEITY);
return (ScriptDate::Date)StoryPage::Get(story_page_id)->date;
}
/* static */ bool ScriptStoryPage::SetDate(StoryPageID story_page_id, ScriptDate::Date date)
{
EnforcePrecondition(false, IsValidStoryPage(story_page_id));
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
return ScriptObject::Command<CMD_SET_STORY_PAGE_DATE>::Do(story_page_id, date);
}
/* static */ bool ScriptStoryPage::Show(StoryPageID story_page_id)
{
EnforcePrecondition(false, IsValidStoryPage(story_page_id));
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
return ScriptObject::Command<CMD_SHOW_STORY_PAGE>::Do(story_page_id);
}
/* static */ bool ScriptStoryPage::Remove(StoryPageID story_page_id)
{
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(false, IsValidStoryPage(story_page_id));
return ScriptObject::Command<CMD_REMOVE_STORY_PAGE>::Do(story_page_id);
}
/* static */ bool ScriptStoryPage::RemoveElement(StoryPageElementID story_page_element_id)
{
EnforcePrecondition(false, ScriptObject::GetCompany() == OWNER_DEITY);
EnforcePrecondition(false, IsValidStoryPageElement(story_page_element_id));
return ScriptObject::Command<CMD_REMOVE_STORY_PAGE_ELEMENT>::Do(story_page_element_id);
}
/* static */ ScriptStoryPage::StoryPageButtonFormatting ScriptStoryPage::MakePushButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags)
{
StoryPageButtonData data;
data.SetColour((Colours)colour);
data.SetFlags((::StoryPageButtonFlags)flags);
if (!data.ValidateColour()) return UINT32_MAX;
if (!data.ValidateFlags()) return UINT32_MAX;
return data.referenced_id;
}
/* static */ ScriptStoryPage::StoryPageButtonFormatting ScriptStoryPage::MakeTileButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags, StoryPageButtonCursor cursor)
{
StoryPageButtonData data;
data.SetColour((Colours)colour);
data.SetFlags((::StoryPageButtonFlags)flags);
data.SetCursor((::StoryPageButtonCursor)cursor);
if (!data.ValidateColour()) return UINT32_MAX;
if (!data.ValidateFlags()) return UINT32_MAX;
if (!data.ValidateCursor()) return UINT32_MAX;
return data.referenced_id;
}
/* static */ ScriptStoryPage::StoryPageButtonFormatting ScriptStoryPage::MakeVehicleButtonReference(StoryPageButtonColour colour, StoryPageButtonFlags flags, StoryPageButtonCursor cursor, ScriptVehicle::VehicleType vehtype)
{
StoryPageButtonData data;
data.SetColour((Colours)colour);
data.SetFlags((::StoryPageButtonFlags)flags);
data.SetCursor((::StoryPageButtonCursor)cursor);
data.SetVehicleType((::VehicleType)vehtype);
if (!data.ValidateColour()) return UINT32_MAX;
if (!data.ValidateFlags()) return UINT32_MAX;
if (!data.ValidateCursor()) return UINT32_MAX;
if (!data.ValidateVehicleType()) return UINT32_MAX;
return data.referenced_id;
}
|