miguel.horta/openttd-android
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix #10438: [GS] Validate story page element type for ScriptStoryPage::NewElement (#11888)

Browse Source 
Fixes a crash that happens if an invalid StoryPageElementType is passed to ScriptStoryPage::NewElement.

Adds an enforced precondition that tests the validity of StoryPageElementType.

Adds GSStoryPage::IsValidStoryPageElementType to the API.
This commit is contained in:
SamuXarick
2024-01-27 21:11:02 +00:00
committed by GitHub
parent 6d276698b6
commit 76f0f9e386
3 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/script/api/script_story_page.hpp
View File

@@ -179,6 +179,13 @@ public:
*/
static bool IsValidStoryPageElement(StoryPageElementID story_page_element_id);
/**
* Check whether this is a valid story page element type.
* @param type The StoryPageElementType to check.
* @return True if and only if this story page element type is valid.
*/
static bool IsValidStoryPageElementType(StoryPageElementType type);
/**
* Create a new story page.
* @param company The company to create the story page for, or ScriptCompany::COMPANY_INVALID for all.
@@ -202,6 +209,7 @@ public:
* @return The new StoryPageElementID, or STORY_PAGE_ELEMENT_INVALID if it failed.
* @pre ScriptCompanyMode::IsDeity().
* @pre IsValidStoryPage(story_page).
* @pre IsValidStoryPageElementType(type).
* @pre (type != SPET_TEXT && type != SPET_LOCATION) || (text != null && len(text) != 0).
* @pre type != SPET_LOCATION || ScriptMap::IsValidTile(reference).
* @pre type != SPET_GOAL || ScriptGoal::IsValidGoal(reference).