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

Nit: Configuration "spawnRateModifier" misnamed #14

Open
fnar opened this issue Dec 30, 2022 · 1 comment
Open

Nit: Configuration "spawnRateModifier" misnamed #14

fnar opened this issue Dec 30, 2022 · 1 comment

Comments

@fnar
Copy link

fnar commented Dec 30, 2022

spawnRateModifier, although honest, is a bit inaccurate. With this name, it implies that by increasing the modifier (default of 1.0) then the rate of spawns would also increase. This is not the case as per the comment:

# This multiplier is applied on the spawner's spawn delay each time a mob is spawned. 
# Can be used to make mobs spawned exponentially faster or slower.

Kudos for the documentation, but we can do even better.

This configuration should instead be named spawnDelayMultiplier or something similar, indicating that by increasing the value that the delay is increased, rather than the rate of spawn.

@fnar
Copy link
Author

fnar commented Dec 30, 2022

Bonus points if the documentation comment also indicates the direction (e.g. "Increasing this value increases the delay -- amount of time -- between spawns generated by this spawner.")

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

1 participant