PettingZoo icon indicating copy to clipboard operation
PettingZoo copied to clipboard

[Bug Report] Waterworld Documentation bug - food color

Open yidilozdemir opened this issue 6 months ago • 0 comments

In the SISL/Waterworld section, there is a mismatch between the documentation and the code on the color of the objects.

"For example, by default there are 5 agents (purple), 5 food targets (red) and 10 poison targets (green)."

But in waterworld_models, the rgb colors of food targets -- evaders correspond to green (ln 67)

class Evaders(MovingObject):
    def __init__(self, x, y, vx, vy, radius=0.03, collision_type=2, max_speed=100, nutrition=2):
        super().__init__(x, y, radius=radius)

        self.body.velocity = vx, vy

        self.color = (145, 250, 116)

and color of poison target corresponds to red (ln 88)

class Poisons(MovingObject):
    def __init__(
        self, x, y, vx, vy, radius=0.015 * 3 / 4, collision_type=3, max_speed=100
    ):
        super().__init__(x, y, radius=radius)

        self.body.velocity = vx, vy

        self.color = (238, 116, 106)

Did I get that right? Should I make a PR to fix the docs?

  • [X] I have checked that there is no similar issue in the repo

yidilozdemir avatar Aug 07 '24 19:08 yidilozdemir