Document ResourceManager.load runtime URL and virtualPath boundary

Aperta Adatta ai principianti
#3,104 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
85/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Aggiorna engine-knowledge/references/resource-ownership.md con la versione e la relativa voce di routing per coprire il caricamento delle risorse in fase di esecuzione. Usa i link alle fonti nell’issue per verificare il contratto dichiarato per ResourceManager.load() e ProjectLoader nella versione 2.0.0-alpha.43. Il lavoro è completo quando il riferimento spiega gli URL del browser e i valori esatti registrati di virtualPath, esclude i percorsi del filesystem host ed è pianificato per la prossima versione di Engine.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Problem

The exact-version engine-knowledge Skill does not currently explain what kind of path ResourceManager.load() accepts. Downstream authoring tools can therefore confuse an editor project path or host filesystem path with a runtime load key, producing requests such as resourceManager.load("/Textures/icon.png") that become browser HTTP requests and may 404.

Source-backed contract

In 2.0.0-alpha.43:

  • ResourceManager.load() resolves an ordinary input through baseUrl or an exact registered virtualPath.
  • ProjectLoader registers runtime virtual resources from project data.files.
  • The final request uses XMLHttpRequest; it does not read the host filesystem.

Source:

Requested change

Add the following runtime semantic to the existing versioned engine-knowledge/references/resource-ownership.md, and include runtime resource loading in its routing entry:

resourceManager.load() resolves a browser URL or an exact virtualPath already registered with ResourceManager; it never reads a host filesystem path.

No runtime API change or new Skill reference is needed. Because the Skill ships with @galacean/engine, publish the documentation with the next Engine version rather than changing an already published package.

Lingua principale
TypeScript
Stelle
5.9k
Fork
413
Merge medio
16h 17m
PR unite (30g)
41

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di galacean/engine

Tutte le issue di galacean/engine

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.