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

Unclear documentation #1

Open
1b8 opened this issue Feb 18, 2016 · 1 comment
Open

Unclear documentation #1

1b8 opened this issue Feb 18, 2016 · 1 comment

Comments

@1b8
Copy link

1b8 commented Feb 18, 2016

Some of the documentation is unclear:

Is id the unique entity id, the numerical entity type id, or the entity name?

What's the difference between mobType, entityType and objectType?

What is player?

It's also unclear that position and velocity are Vec3s.

@rom1504
Copy link
Member

rom1504 commented Feb 18, 2016

  • id is the unique entity id (not the type)
  • entityType is the numerical type, mobType and objectType are the type in letters, I agree these names are bad, maybe they should be type and name instead
  • players are entities, entity.player is the player of the entity if entity is a player. It's kind of optional, I don't think any code use this anymore, it could probably be removed
  • yeah they are indeed

I'll clarify the doc / make the changes needing to clarify stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants