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

more detailed docs/guides #58

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

more detailed docs/guides #58

wants to merge 1 commit into from

Conversation

zkat
Copy link
Owner

@zkat zkat commented Sep 25, 2022

No description provided.

@zkat zkat changed the title Zkat/docs more detailed docs/guides Sep 25, 2022
Wrapper for Actor entities. In terms of Scorers, Thinkers, and Actions, this is the [`Entity`] actually _performing_ the action, rather than the entity a Scorer/Thinker/Action is attached to. Generally, you will use this entity when writing Queries for Action and Scorer systems.
* Wrapper for Actor entities. In terms of Scorers, Thinkers, and Actions, this
* is the [`Entity`] actually _performing_ the action, rather than the entity a
* Scorer/Thinker/Action is attached to. Generally, you will use this entity
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is one of the more confusing lines of the docs, I think.

In my case, the entity performing the action IS the entity with a ThinkerBuilder component.

A new user doesn't understand the difference between Action and ActionBuilder, (same for scorer/thinker), so this line just confuses them more, I think

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, I think your third paragraph is the issue here, really.

One of the things I've struggled with most w/ Big Brain ergonomics is how to have the Action/ActionBuilder (etc) distinction without overwhelming new users, but this might be because I've tried to hard to sweep it under the rug in "basic" cases...

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

Successfully merging this pull request may close these issues.

2 participants