Skip to content

Conversation

@willeastcott
Copy link
Contributor

  • Restores callback API ref descriptions.
  • Removes AnimSetter (internal) and CreateScriptCallback (should have been removed with legacy scripts code).
  • Correctly set return type of void where applicable (otherwise any is assumed).

Fixes #7604

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

@willeastcott willeastcott added bug Something isn't working docs Documentation related labels Apr 25, 2025
@willeastcott willeastcott self-assigned this Apr 25, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request restores callback API reference descriptions and updates callback declarations throughout the codebase. It also removes legacy callbacks and explicitly sets return types to void to avoid defaulting to any.

Reviewed Changes

Copilot reviewed 21 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/scene/mesh-instance.js Updated callback documentation for CalculateSortDistanceCallback
src/scene/graph-node.js Updated callback documentation for find/forEach node callbacks
src/platform/net/http.js Reformatted HttpResponseCallback with explicit return type
src/platform/input/mouse.js Updated LockMouseCallback documentation with explicit void return
src/framework/xr/xr-manager.js Revised XR callback documentation and updated references
src/framework/xr/xr-hit-test.js Adjusted callback documentation for XR hit test callbacks
src/framework/xr/xr-anchors.js Updated XR anchor callback documentation
src/framework/xr/xr-anchor.js Revised XR anchor persist and forget callbacks
src/framework/script.js Removed legacy CreateScriptCallback and updated createLoadingScreen callback
src/framework/scene-registry.js Updated several scene registry callback documentations with explicit void return
src/framework/handlers/model.js Updated AddParserCallback documentation
src/framework/handlers/loader.js Updated ResourceLoaderCallback documentation; fixed a spelling error in a comment
src/framework/handlers/handler.js Revised ResourceHandlerCallback documentation with explicit void return
src/framework/components/camera/component.js Updated camera callbacks documentation with explicit void return
src/framework/asset/asset.js Updated AssetReadyCallback documentation
src/framework/asset/asset-registry.js Updated asset registry callbacks with explicit void return and clarified types
src/framework/app-base.js Updated several AppBase callback documentations with explicit void return
src/framework/anim/evaluator/anim-target.js Updated parameter type for the animation setter callback
src/core/wasm-module.js Revised WasmModule callbacks documentation
src/core/event-handler.js Updated HandleEventCallback documentation with explicit void return

@willeastcott willeastcott merged commit e2fa4fe into main Apr 25, 2025
7 checks passed
@willeastcott willeastcott deleted the callback-docs branch April 25, 2025 10:37
willeastcott added a commit that referenced this pull request Apr 25, 2025
* [FIX] Restore callback descriptions

* Revert package-lock.json

* Grammar tweak
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working docs Documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

All descriptions are missing from @typedef and @callback entries in the API reference

3 participants