Tidy and document the codebase. #179
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
No functional difference, just simplifies the class a little.
Remove the unnecessary "pre-scene" that was being created whilst loading the main scene. This also fixes a bug where some objects were getting trapped in the pre-scene after it was disposed, breaking the objects.
Use "error" and "errorMessage" instead of "e", "err", or "errr".
Expand API interface names from "...Req" and "...Res" to "...Request" and "...Response".
- Rename `findErrorMsg` to `findErrorMessage`. - Move the `findErrorMessage` function from the Metaverse module to the Debugging module. - Update the `findErrorMessage` function.
- Convert `Log` IIFE into a class for better readability. - Document Log methods. - Rename log type "COMM" to "NETWORK".
- Unite MetaverseOps functions as API class. - Update API methods documentation. - Move `MetaverseInfoAPI` path and `MetaverseInfoResponse` interface from the APIAccount module to the APIInfo module. - Simplify the process of fetching data from the Metaverse API.
- Remove: `P` to print all meshes to console. - Move `Shift+/` and `resetPosition` to the KeyboardInput module.
- Rename "DomainMgr" to "DomainManager" for clarity. - Convert DomainManager from an object literal to a static class for clarity. - Remove unused functions, methods, types, and variables. - Use `private` syntax instead of `#_` for clarity and consistency. - Add TSDoc comments to all necessary class members. - Expand and clarify all method and variable names. For example: `pD` to `domain`, and `avaMixer` to `avatarMixer`. - Clarify all log messages. - Make unused promises synchronous.
- Rename "MetaverseMgr" to "MetaverseManager" for clarity. - Convert MetaverseManager from an object literal to a static class for clarity. - Remove unused functions, methods, types, and variables. - Use `private` syntax instead of `#_` for clarity and consistency. - Add TSDoc comments to all necessary class members.
- Convert AudioIO to a static class. - Use `private` syntax instead of `$` for clarity. - Add TSDoc comments to all necessary class members. - Remove unused methods. - Create AudioLevel UI component to simplify displaying the mic input level.
- Convert AvatarStoreInterface from an object literal to a static class for clarity. - Add TSDoc comments to all class members. - Rename "AvatarEntry" and "AvatarEntryMap" interfaces to "AvatarModel" and "AvatarModelMap" for clarity.
- Add TSDoc comments to all necessary component methods.
- Remove unused component methods.
- Clarify method names.
- Simplify component logic.
- Ensure consistent formatting:
- Style-Template-Script for all components.
- `return {};` syntax for data and setup options to ensure consistent handling of `this`.
- One blank line between all component options for clarity.
- Convert Utility from an object literal to a static class for clarity. - Clarify variable and method names. - Add TSDoc comments to all methods.
- Rename "AudioMgr" to "AudioManager" for clarity. - Convert AudioManager from an object literal to a static class for clarity. - Remove unused methods and variables. - Clarify variable and method names. - Add TSDoc comments to various methods.
- Convert Places from an object literal to a static class for clarity. - Add TSDoc comments.
- Fix incorrect global component name. - Correct broken import of `AudioMgr` to `AudioManager`. - Fix incorrect active Domain assignment.
- Fix typos and grammar. - Add TSDoc comments to various classes and methods. - Remove useless getters/setters. - Use explicit type imports.
My bad, I forgot this was part of our coding standard.
Remove calls to the DefaultRenderingPipeline from VScene, since that pipeline is already managed by the ZoneEntityController.
…t light intensity
ctrlaltdavid
approved these changes
Jul 21, 2023
This was referenced Sep 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds 141 documenting comments, removes 23 uses of
eslint-disable, and addresses a few bugs.Bugs Addressed:
0. 699bdaf.Features added:
To be addressed in further PRs:
object/GameObject.ts:165) The method of removing a GameObject from the scene is rather peculiar. This should be documented with comments and tested.