Skip to content

[web] common.j: GetPlayerStartLocation - Incorrect or misleading comment #233

Description

@EzraZebra

jassdoc/common.j

Line 11954 in deddec4

native GetPlayerStartLocation takes player whichPlayer returns integer

This returns the ID of the start location's default player. The way this comment is worded gives the impression that it returns the ID of the player that spawns at that location, even if it doesn't match the start location's default player.

For example:

  • Red (ID 0) start location in the north
  • Blue (ID 1) start location in the south
  • Player 1 (ID 0) spawn in the south
  • Player 2 (ID 1) spawns in the north

Current comment gives the impression that GetPlayerStartLocation(Player(0)) will return 0 and GetPlayerStartLocation(Player(1)) will return 1, but in this case it would be the other way around.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions