-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Tighten up types for Entity API #7560
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
willeastcott
wants to merge
8
commits into
main
Choose a base branch
from
type-addcomponent
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ddb2dea
Tighten up types for Entity API
willeastcott ae2cbdf
Improve typedef description
willeastcott 892b200
Add support for custom components
willeastcott d133045
Merge branch 'main' into type-addcomponent
willeastcott 8d5f727
Merge branch 'main' into type-addcomponent
willeastcott 51ed758
Merge branch 'main' into type-addcomponent
willeastcott c442d60
Update src/framework/entity.js
willeastcott 269e8eb
Replace addComponent overloads with conditional-type signature
willeastcott File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -30,6 +30,33 @@ import { getApplication } from './globals.js'; | |||||
| * @import { SpriteComponent } from './components/sprite/component.js' | ||||||
| */ | ||||||
|
|
||||||
| /** | ||||||
| * @typedef {{ | ||||||
| * anim: AnimComponent; | ||||||
| * animation: AnimationComponent; | ||||||
| * audiolistener: AudioListenerComponent; | ||||||
| * button: ButtonComponent; | ||||||
| * camera: CameraComponent; | ||||||
| * collision: CollisionComponent; | ||||||
| * element: ElementComponent; | ||||||
| * gsplat: GSplatComponent; | ||||||
| * layoutchild: LayoutChildComponent; | ||||||
| * layoutgroup: LayoutGroupComponent; | ||||||
| * light: LightComponent; | ||||||
| * model: ModelComponent; | ||||||
| * particlesystem: ParticleSystemComponent; | ||||||
| * render: RenderComponent; | ||||||
| * rigidbody: RigidBodyComponent; | ||||||
| * screen: ScreenComponent; | ||||||
| * script: ScriptComponent; | ||||||
| * scrollbar: ScrollbarComponent; | ||||||
| * scrollview: ScrollViewComponent; | ||||||
| * sound: SoundComponent; | ||||||
| * sprite: SpriteComponent; | ||||||
| * }} ComponentMap A map of component names to their class types. Facilitates typings for | ||||||
| * {@link Entity#addComponent}. | ||||||
|
willeastcott marked this conversation as resolved.
Outdated
|
||||||
| */ | ||||||
|
|
||||||
| /** | ||||||
| * @param {Component} a - First object with `order` property. | ||||||
| * @param {Component} b - Second object with `order` property. | ||||||
|
|
@@ -334,49 +361,71 @@ class Entity extends GraphNode { | |||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Create a new component and add it to the entity. Use this to add functionality to the entity | ||||||
| * like rendering a model, playing sounds and so on. | ||||||
| * | ||||||
| * @param {string} type - The name of the component to add. Valid strings are: | ||||||
| * | ||||||
| * - "anim" - see {@link AnimComponent} | ||||||
| * - "animation" - see {@link AnimationComponent} | ||||||
| * - "audiolistener" - see {@link AudioListenerComponent} | ||||||
| * - "button" - see {@link ButtonComponent} | ||||||
| * - "camera" - see {@link CameraComponent} | ||||||
| * - "collision" - see {@link CollisionComponent} | ||||||
| * - "element" - see {@link ElementComponent} | ||||||
| * - "gsplat" - see {@link GSplatComponent} | ||||||
| * - "layoutchild" - see {@link LayoutChildComponent} | ||||||
| * - "layoutgroup" - see {@link LayoutGroupComponent} | ||||||
| * - "light" - see {@link LightComponent} | ||||||
| * - "model" - see {@link ModelComponent} | ||||||
| * - "particlesystem" - see {@link ParticleSystemComponent} | ||||||
| * - "render" - see {@link RenderComponent} | ||||||
| * - "rigidbody" - see {@link RigidBodyComponent} | ||||||
| * - "screen" - see {@link ScreenComponent} | ||||||
| * - "script" - see {@link ScriptComponent} | ||||||
| * - "scrollbar" - see {@link ScrollbarComponent} | ||||||
| * - "scrollview" - see {@link ScrollViewComponent} | ||||||
| * - "sound" - see {@link SoundComponent} | ||||||
| * - "sprite" - see {@link SpriteComponent} | ||||||
| * | ||||||
| * @param {object} [data] - The initialization data for the specific component type. Refer to | ||||||
| * each specific component's API reference page for details on valid values for this parameter. | ||||||
| * @returns {Component|null} The new Component that was attached to the entity or null if there | ||||||
| * was an error. | ||||||
| * Add a built-in component to the entity. The associated component system must be registered | ||||||
| * with the application. | ||||||
| * | ||||||
| * @template {keyof ComponentMap} T | ||||||
| * @overload | ||||||
| * @param {T} type - The type of built-in component to add. Can be: | ||||||
| * - 'anim' - see {@link AnimComponent} | ||||||
| * - 'animation' - see {@link AnimationComponent} | ||||||
| * - 'audiolistener' - see {@link AudioListenerComponent} | ||||||
| * - 'button' - see {@link ButtonComponent} | ||||||
| * - 'camera' - see {@link CameraComponent} | ||||||
| * - 'collision' - see {@link CollisionComponent} | ||||||
| * - 'element' - see {@link ElementComponent} | ||||||
| * - 'gsplat' - see {@link GSplatComponent} | ||||||
| * - 'layoutchild' - see {@link LayoutChildComponent} | ||||||
| * - 'layoutgroup' - see {@link LayoutGroupComponent} | ||||||
| * - 'light' - see {@link LightComponent} | ||||||
| * - 'model' - see {@link ModelComponent} | ||||||
| * - 'particlesystem' - see {@link ParticleSystemComponent} | ||||||
| * - 'render' - see {@link RenderComponent} | ||||||
| * - 'rigidbody' - see {@link RigidBodyComponent} | ||||||
| * - 'screen' - see {@link ScreenComponent} | ||||||
| * - 'script' - see {@link ScriptComponent} | ||||||
| * - 'scrollbar' - see {@link ScrollbarComponent} | ||||||
| * - 'scrollview' - see {@link ScrollViewComponent} | ||||||
| * - 'sound' - see {@link SoundComponent} | ||||||
| * - 'sprite' - see {@link SpriteComponent} | ||||||
| * @param {Partial<ComponentMap[T]>} [data] - Optional initialization data for the component. | ||||||
| * Refer to each specific component's API reference page for details on valid values for this | ||||||
| * parameter. | ||||||
| * @returns {ComponentMap[T] | null} The newly added component or null in the case of an error. | ||||||
| * @example | ||||||
| * const entity = new pc.Entity(); | ||||||
| * | ||||||
| * // Add a light component with default properties | ||||||
| * entity.addComponent("light"); | ||||||
| * entity.addComponent('light'); | ||||||
| * | ||||||
| * // Add a camera component with some specified properties | ||||||
| * entity.addComponent("camera", { | ||||||
| * // Add a camera component with some initialization data | ||||||
| * entity.addComponent('camera', { | ||||||
| * fov: 45, | ||||||
| * clearColor: new pc.Color(1, 0, 0) | ||||||
| * }); | ||||||
| */ | ||||||
| /** | ||||||
| * Add a custom component to the entity. The associated component system must be registered | ||||||
| * with the application. | ||||||
| * | ||||||
| * @overload | ||||||
| * @param {string} type - The type of custom component to add. | ||||||
| * @param {any} [data] - Optional initialization data for the component. | ||||||
| * @returns {Component | null} The newly added component or null in the case of an error. | ||||||
| * @example | ||||||
| * const entity = new pc.Entity(); | ||||||
| * | ||||||
| * // Add a custom component with some initialization data | ||||||
| * entity.addComponent('custom', { | ||||||
| * foo: 'bar' | ||||||
| * }); | ||||||
| */ | ||||||
| /** | ||||||
| * @template {keyof ComponentMap} T | ||||||
| * @param {T | string} type - The type of component to add. | ||||||
| * @param {Partial<ComponentMap[T]> | any} [data] - Optional initialization data for the component. | ||||||
|
||||||
| * @param {Partial<ComponentMap[T]> | any} [data] - Optional initialization data for the component. | |
| * @param {unknown} [data] - Optional initialization data for the component. |
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.
Uh oh!
There was an error while loading. Please reload this page.