diff options
Diffstat (limited to 'src/script/api/script_goal.hpp')
| -rw-r--r-- | src/script/api/script_goal.hpp | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/src/script/api/script_goal.hpp b/src/script/api/script_goal.hpp index 2fad1e843..ee0077663 100644 --- a/src/script/api/script_goal.hpp +++ b/src/script/api/script_goal.hpp @@ -42,6 +42,28 @@ public: GT_COMPANY = ::GT_COMPANY, ///< Destination is a company. }; + enum QuestionButton { + /* Note: these values represent part of the string list starting with STR_GOAL_QUESTION_BUTTON_CANCEL */ + BUTTON_CANCEL = (1 << 0), ///< Cancel button. + BUTTON_OK = (1 << 1), ///< OK button. + BUTTON_NO = (1 << 2), ///< No button. + BUTTON_YES = (1 << 3), ///< Yes button. + BUTTON_DECLINE = (1 << 4), ///< Decline button. + BUTTON_ACCEPT = (1 << 5), ///< Accept button. + BUTTON_IGNORE = (1 << 6), ///< Ignore button. + BUTTON_RETRY = (1 << 7), ///< Retry button. + BUTTON_PREVIOUS = (1 << 8), ///< Previous button. + BUTTON_NEXT = (1 << 9), ///< Next button. + BUTTON_STOP = (1 << 10), ///< Stop button. + BUTTON_START = (1 << 11), ///< Start button. + BUTTON_GO = (1 << 12), ///< Go button. + BUTTON_CONTINUE = (1 << 13), ///< Continue button. + BUTTON_RESTART = (1 << 14), ///< Restart button. + BUTTON_POSTPONE = (1 << 15), ///< Postpone button. + BUTTON_SURRENDER = (1 << 16), ///< Surrender button. + BUTTON_CLOSE = (1 << 17), ///< Close button. + }; + /** * Check whether this is a valid goalID. * @param goal_id The GoalID to check. @@ -56,6 +78,7 @@ public: * @param type The type of the goal. * @param destination The destination of the #type type. * @return The new GoalID, or GOAL_INVALID if it failed. + * @pre No ScriptCompanyMode may be in scope. * @pre goal != NULL && len(goal) != 0. * @pre company == COMPANY_INVALID || ResolveCompanyID(company) != COMPANY_INVALID. */ @@ -65,9 +88,38 @@ public: * Remove a goal from the list. * @param goal_id The goal to remove. * @return True if the action succeeded. + * @pre No ScriptCompanyMode may be in scope. * @pre IsValidGoal(goal_id). */ static bool Remove(GoalID goal_id); + + /** + * Ask a question. + * @param uniqueid Your unique id to distinguish results of multiple questions in the returning event. + * @param company The company to ask the question, or ScriptCompany::COMPANY_INVALID for all. + * @param question The question to ask (can be either a raw string, or a ScriptText object). + * @param buttons Any combinations (at least 1, up to 3) of buttons defined in QuestionButton. Like BUTTON_YES + BUTTON_NO. + * @return True if the action succeeded. + * @pre No ScriptCompanyMode may be in scope. + * @pre question != NULL && len(question) != 0. + * @pre company == COMPANY_INVALID || ResolveCompanyID(company) != COMPANY_INVALID. + * @pre CountBits(buttons) >= 1 && CountBits(buttons) <= 3. + * @note Replies to the question are given by you via the event ScriptEvent_GoalQuestionAnswer. + * @note There is no guarantee you ever get a reply on your question. + */ + static bool Question(uint16 uniqueid, ScriptCompany::CompanyID company, Text *question, int buttons); + + /** + * Close the question on all clients. + * @param uniqueid The uniqueid of the question you want to close. + * @return True if the action succeeded. + * @pre No ScriptCompanyMode may be in scope. + * @note If you send a question to a single company, and get a reply for them, + * the question is already closed on all clients. Only use this function if + * you want to timeout a question, or if you send the question to all + * companies, but you are only interested in the reply of the first. + */ + static bool CloseQuestion(uint16 uniqueid); }; #endif /* SCRIPT_GOAL_HPP */ |