Skip to content

Fix Tutorial PrintJSON type mapping and Javadoc typos - #128

Merged
cjmang merged 1 commit into
ArchipelagoMW:mainfrom
TypoScan3000:docs/fix-typos
Oct 27, 2026
Merged

cjmang merged 1 commit into
ArchipelagoMW:mainfrom
TypoScan3000:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown
Contributor

Summary

  • Print/APPrintJsonType.java: Tutorial was annotated @SerializedName("entrance_name"), which is a JSON message part type (it is used correctly in APPrintType.java), not a PrintJSON type. The server sends "type": "Tutorial" (see docs/network protocol.md in the main Archipelago repo), so those messages currently deserialize to null and WebSocket reports them as Unknown. Changed to @SerializedName("Tutorial"). This is a behaviour change: Tutorial messages will now arrive as APPrintJsonType.Tutorial instead of Unknown.
  • network/client/SetPacket.java: the POWER operation's doc said "Multiplies the current value ... to the power of @value" (copied from MULTIPLY) -> "Raises the current value ... to the power of @value"; "the servers data storage" -> "the server's data storage".
  • EventManager.java: "supplied Object must have..." -> "The supplied Object must have..." in the registerListener / unRegisterListener Javadoc.

Apart from the @SerializedName value, comments/Javadoc only.

APPrintJsonType.Tutorial was annotated @SerializedName("entrance_name"),
which is a JSONMessagePart type rather than a PrintJSON type. The server
sends type "Tutorial" (docs/network protocol.md), so those messages were
deserialized as null and reported as Unknown.

Also fix the POWER operation doc (copied from MULTIPLY), a missing
possessive, and two sentences missing their article in EventManager.

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
@cjmang
cjmang merged commit 8e8b950 into ArchipelagoMW:main Oct 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants