Skip to content

Add missing SDK methods to docs#9

Open
cloud9c wants to merge 6 commits intomainfrom
kire5030/eng-676-add-missing-sdk-methods-to-docs
Open

Add missing SDK methods to docs#9
cloud9c wants to merge 6 commits intomainfrom
kire5030/eng-676-add-missing-sdk-methods-to-docs

Conversation

@cloud9c
Copy link
Copy Markdown
Contributor

@cloud9c cloud9c commented Apr 1, 2026

Summary

  • Document 10 missing SDK methods across initialization, lobbies, remote storage, and P2P pages: toggleOverlay, loadScript, updateLoadProgressZeroToOne, loadComplete, setEngineInstance, getLobbyInviteLink, deleteRemoteFile, getP2PMaxPayloadSize, getP2PMaxIncomingMessages
  • Add sdk/friends to the sidebar navigation (page existed but was not linked)
  • All method signatures verified against latest sdk-js main branch

Resolves ENG-676

Test plan

  • Verify Mintlify renders all new sections correctly (overlay, loading helpers, invite links, deleting files, message limits)
  • Confirm friends page appears in SDK sidebar under Features
  • Check code examples in all 3 languages (Godot, Unity, JavaScript) render properly in CodeGroup components

🤖 Generated with Claude Code

cloud9c and others added 2 commits April 1, 2026 15:33
Document toggleOverlay, loadScript, updateLoadProgressZeroToOne,
loadComplete, setEngineInstance, getLobbyInviteLink, deleteRemoteFile,
getP2PMaxPayloadSize, and getP2PMaxIncomingMessages. Also add the
friends page to the sidebar navigation.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The CLI binds to port 0 (ephemeral) so the OS assigns an available
port, rather than hardcoding 7777.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@cloud9c cloud9c marked this pull request as ready for review April 3, 2026 00:45
sdk/lobbies.mdx Outdated
WavedashSDK.got_lobby_invite_link.connect(_on_got_invite_link)

func get_invite_link():
WavedashSDK.get_lobby_invite_link()
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we sure this exists in the godot repo?

<CodeGroup>
```gdscript Godot
func toggle_overlay():
WavedashSDK.toggle_overlay()
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this exist?

@franzwarning
Copy link
Copy Markdown
Member

go through and make sure these actually exist cuz I think godot (at least) hasn't been updated for a while. double check js and unity too

cloud9c and others added 4 commits April 4, 2026 22:00
- toggle_overlay() → show_overlay() (actual method name in sdk-godot)
- Remove get_lobby_invite_link() Godot example (method doesn't exist in sdk-godot)
- Remove delete_remote_file() Godot example (method doesn't exist in sdk-godot)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Restore current_stats_received signal connection (was accidentally removed)
- Remove store_stats() Godot example (method doesn't exist, stats are stored
  automatically by set_stat_int(store_now=true) and set_achievement())
- Fix note claiming set_achievement() accepts store_now param in Godot (it doesn't)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Godot: Wavedash. → WavedashSDK. in index.mdx
- Unity: lobbyType → lobbyVisibility, sortOrder → sortMethod, localPath → filePath
- Unity: remove DeleteRemoteFile example (method doesn't exist)
- Unity: fix SetAchievement note (no storeNow param)
- JS: add missing P2PConfig fields (messageSize, maxIncomingMessages)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- uploadLeaderboardScore: use positional args, not object
- LOBBY_USERS_UPDATED payload: id → userId
- LOBBY_MESSAGE payload: id → messageId
- Godot backend signal handlers: add missing payload param
- UGC_VISIBILITY_PUBLIC → integer 0 (constant doesn't exist in JS SDK)
- P2P param table: fix name (data → payload) and order to match signature

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@cloud9c
Copy link
Copy Markdown
Contributor Author

cloud9c commented Apr 5, 2026

did an audit after installing sdk-unity and sdk-godot locally

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