https://wiki.returnofreckoning.com/index.php?action=history&feed=atom&title=API%3ASendHelpMessageAPI:SendHelpMessage - Revision history2026-10-18T01:23:07ZRevision history for this page on the wikiMediaWiki 1.43.11https://wiki.returnofreckoning.com/index.php?title=API:SendHelpMessage&diff=30698&oldid=prevMaintenance script: UI Lua API import (WAR 1.4.8)2026-10-16T19:48:41Z<p>UI Lua API import (WAR 1.4.8)</p>
<p><b>New page</b></p><div>{{LuaApi|group=Social}}<br />
Sends a help request to the server: an appeal (petition), a report, a bug report, feedback, or an update or cancellation of an appeal.<br />
<br />
<pre><br />
SendHelpMessage(helpType, topic, category, details, field1, string1, field2, string2, field3, string3, field4, string4)<br />
</pre><br />
<br />
== Arguments ==<br />
;helpType : <code>number</code> – A <code>GameData.HelpType</code> value: <code>CREATE_APPEAL_NON_VALIDATED</code> (0), <code>CREATE_APPEAL_NAMING_VIOLATION</code> (1), <code>CREATE_APPEAL_VIOLATION_REPORT</code> (2), <code>CREATE_APPEAL_GOLD_SELLER</code> (3), <code>CREATE_BUG_REPORT</code> (4), <code>CREATE_FEEDBACK</code> (5), <code>UPDATE_APPEAL</code> (6), <code>CANCEL_APPEAL</code> (7).<br />
;topic : <code>number</code> – Subtype of the message, for appeals a <code>GameData.AppealTopic</code> value; for bug reports and feedback the selected type. Sent as an 8-bit value.<br />
;category : <code>wstring</code> – Topic category.<br />
;details : <code>wstring</code> – The text of the message.<br />
;field1 : <code>number</code> – Field id for <code>string1</code>.<br />
;string1 : <code>wstring</code> – Extra text field 1.<br />
;field2 : <code>number</code> – Field id for <code>string2</code>.<br />
;string2 : <code>wstring</code> – Extra text field 2.<br />
;field3, string3, field4, string4 : <code>number</code>, <code>wstring</code> – Not used by the client, but must be given with these types.<br />
<br />
== Returns ==<br />
Nothing.<br />
<br />
== Details ==<br />
* If <code>details</code> is empty and <code>helpType</code> is not <code>CANCEL_APPEAL</code>, the client shows an error dialog and sends nothing.<br />
* Which of the other arguments are sent depends on <code>helpType</code>. Bug reports and feedback send <code>topic</code> and <code>details</code>; <code>UPDATE_APPEAL</code> sends only <code>details</code>; <code>CANCEL_APPEAL</code> sends no text.<br />
* Any <code>helpType</code> above 7 sends nothing.<br />
* If the Lua state is not available, nothing happens.<br />
* The function needs at least twelve arguments and only reads the last twelve.<br />
<br />
== Errors ==<br />
None besides the generic ''Invalid Parameters'' message when an argument has the wrong type.<br />
<br />
== Example ==<br />
Sending a bug report, from <code>default/ea_helpwindow/source/bugreportwindow.lua</code>:<br />
<pre><br />
SendHelpMessage(GameData.HelpType.CREATE_BUG_REPORT, BugReportWindow.selectedType, L"",<br />
TextEditBoxGetText("BugReportWindowText"), 0, L"", 0, L"", 0, L"", 0, L"")<br />
</pre><br />
<br />
The parameter list, as documented in the same file:<br />
<pre><br />
-- SendHelpMessage expects the following params:<br />
-- param1 (number) = The type of help message this is, defined by GameData.HelpType.*<br />
-- param2 (number) = The subtype, aka topic, of this message. Defined by GameData.AppealTopic.*<br />
-- param3 (WString) = The sub-subtype, aka topic category, of this message. Defined by EViolation<br />
-- param4 (WString) = The details field of this message.<br />
-- param5 (number) = field ID for string 1<br />
-- param6 (WString) = Generic string1 param<br />
...<br />
</pre><br />
<br />
== See also ==<br />
* [[API:SendBugReport|SendBugReport]]<br />
* [[API:AddTemporaryIgnore|AddTemporaryIgnore]]</div>Maintenance script