8000 Make documentation on player and entity arguments clearer · Issue #595 · CommandAPI/CommandAPI · GitHub
[go: up one dir, main page]

Skip to content
Make documentation on player and entity arguments clearer #595
Open
@Strokkur424

Description

@Strokkur424

Documentation URL

https://commandapi.jorel.dev/9.5.2/argument_entities.html

What the documentation currently says

As it stands, the documentation does not explain the differences between PlayerArgument, EntitySelectorArgument.SinglePlayer, and EntitySelectorArgument.ManyPlayers in a clear enough manner. This can be observed by the many questions about PlayerArguments in the Discord server. Furthermore, the documentation does not talk about differences in using certain entity selectors like @s.

Proposed fix

The first step would be to address #587, which would make performance differences even clearer. The second proposed fix would be to throughoutly explain the use of those arguments as both the backend as an api user (like the return values) and as the frontend for people using the command (mainly behavioral differences in entity selectors).

Something we could also do is move the entity argument higher up in the hierarchy in the left, but that is up to discussion. My reasoning for that is its importance in everyday use.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0