Skip to content

Add initial docs for Entity Pathfinders and Mob Goal API#289

Open
olijeffers0n wants to merge 6 commits intomainfrom
feat/document-mob-goals
Open

Add initial docs for Entity Pathfinders and Mob Goal API#289
olijeffers0n wants to merge 6 commits intomainfrom
feat/document-mob-goals

Conversation

@olijeffers0n
Copy link
Member

@olijeffers0n olijeffers0n commented Jan 24, 2024

I have not extensively used either of these API's in the past, however these seem to work

closes #265

@MiniDigger
Copy link
Member

this needs notes on how vanilla selects which goals to activate and prolly some more caveats on how pathfinding works from somebody who actually uses the pathfinder, iirc it can ge all kinda wonky to call moveTo every tick.

@github-actions
Copy link

github-actions bot commented Nov 25, 2024

built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview d028fab

@olijeffers0n olijeffers0n self-assigned this Dec 28, 2024
@olijeffers0n olijeffers0n added the dev guide This issue or PR aims to introduce developer API documentation label Dec 28, 2024
Comment on lines +22 to +26
:::tip

You can access the Vanilla goals from the `VanillaGoal` class. These are the goals that are used by Vanilla Minecraft.
They are specific to each mob type, so you can't use `VanillaGoal.BEE_ATTACK` on a Zombie, for example.

:::
Copy link
Contributor

@Phoenix616 Phoenix616 Jul 9, 2025

Choose a reason for hiding this comment

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

This feels confusing as it kinda reads as if one could create Vanilla goals entities (especially under the register section) which isn't possible right now.

Copy link
Member

@zlataovce zlataovce left a comment

Choose a reason for hiding this comment

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

the casing is a bit wonky in several places beyond my comments, but otherwise lgtm


:::

## Creating a Custom Goal
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Creating a Custom Goal
## Creating a custom Goal

Location destination = path.getFinalPoint();
```

## Pathfinding Rules
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Pathfinding Rules
## Pathfinding rules

@Phoenix616
Copy link
Contributor

Phoenix616 commented Nov 16, 2025

As far as I'm aware of that's just the grammatical rules of titles in English. Basically everything but "a", "the", etc. should be uppercase if I'm not mistaken?

See Title case (but Wikipedia itself doesn't use that but sentence casing, which imo. Is easier to read but can feel unnatural in headings)

@zlataovce
Copy link
Member

As far as I'm aware of that's just the grammatical rules of titles in English. Basically everything but "a", "the", etc. should be uppercase if I'm not mistaken?

See Title case (but Wikipedia itself doesn't use that but sentence casing, which imo. Is easier to read but can feel unnatural in headings)

we use sentence case in most places throughout the site

@zlataovce zlataovce force-pushed the feat/document-mob-goals branch from d028fab to c948fc3 Compare February 2, 2026 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dev guide This issue or PR aims to introduce developer API documentation meta guide This issue or PR aims to introduce in-depth ways to work with code project: Paper

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Mob goal api guide

8 participants