Skip to content
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

Docs: improve loader documentation #3072

Open
KokoDoko opened this issue May 24, 2024 · 2 comments
Open

Docs: improve loader documentation #3072

KokoDoko opened this issue May 24, 2024 · 2 comments
Labels
docs Relating to documentation in any way stale This issue or PR has not had any activity recently

Comments

@KokoDoko
Copy link

Context

The loader documentation shows an example of creating your own loader screen, but this example is so barebones that it's not clear how to use it. The given example does not work as is. It's not clear what users have to add to get it working.

Proposal

Improve this example code so that it works out of the box.

import * as ex from 'excalibur';
export class MyLoader extends ex.DefaultLoader {
  override onUpdate(engine: Engine, elapsedMilliseconds: number): void {
  }
  override onDraw(ctx: CanvasRenderingContext2D) {
  }
  override async onUserAction(): Promise<void> {
  }
  override async onBeforeLoad(): Promise<void> {
  }
  override async onAfterLoad(): Promise<void> {
  }
}
@eonarheim eonarheim added the docs Relating to documentation in any way label Jun 1, 2024
@eonarheim
Copy link
Member

@KokoDoko Totally agree!

Copy link

github-actions bot commented Aug 2, 2024

This issue hasn't had any recent activity lately and is being marked as stale automatically.

@github-actions github-actions bot added the stale This issue or PR has not had any activity recently label Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Relating to documentation in any way stale This issue or PR has not had any activity recently
Projects
None yet
Development

No branches or pull requests

2 participants