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

Events: missing functions/typos/consistency changes #125

Open
corlick98 opened this issue Mar 20, 2021 · 0 comments
Open

Events: missing functions/typos/consistency changes #125

corlick98 opened this issue Mar 20, 2021 · 0 comments

Comments

@corlick98
Copy link
Contributor

I went through most pages of the API and wrote down any "issues" I could see. I talked to benjamin_dobell and he said I should make a couple issues here instead of pull requests to avoid merge conflicts.

/events/#default-events-global-object

  • onBlindfold(player, blindfolded) is undocumented
  • onload: should this be documented as deprecated?
  • onObjectLeaveScriptingZone: enter_object -> leave_object
  • onObjectPeek: “Called when a player using peek to look under an object” sounds weird
  • onObjectPeek: consistency player->player_color in function handle
  • onObjectSearchStart/End: consistency obj->searched_object or object
  • onObjectStateChange(object, old_guid) is undocumented
  • onPlayerTurnEnd is undocumented (also deprecated I think so it makes sense)
  • onPlayerTurnStart is undocumented (also deprecated I think so it makes sense)
  • tryObjectRandomize(object, player_color) is undocumented

/events/#default-events-object-only

  • onDestroy, onDrop, onPageChange, onPickUp: anObject -> this Object
  • filter/tryObjectEnter obj->enter_object: consistency with tryObjectEnterContainer
  • onPeek: “Called when a player using peek to look under an object” sounds weird
  • onStateChange(old_guid) is undocumented
  • tryRandomize(player_color) is undocumented

/events/#function-details-global-object

  • tryObjectEnterContainer is out of order from what's listed in the table
  • tryObjectEnterContainer: info box says tryObjectEnter
  • onObjectFlick: description says flicks twice
  • onObjectFlick: info box is broken
  • onObjectFlick: info box says onFlick
  • onObjectLeaveScriptingZone: info box enter_object->leave_object
  • onObjectPeek: “Called when a player using peek to look under an object” sounds weird
  • onObjectPeek: consistency player->player_color and “Name of player color that” -> “Player color of the player who”
  • onObjectRandomize: info box spawn_object->randomize_object
  • onObjectSearchStart/End: info box description feels incomplete
  • onSave: JSON doesn’t link to the correct place
  • onSave: info box Save & Apply -> Save & Play

/events/#function-details-object-only

  • tryObjectEnter is out of order from what's listed in the table
  • tryObjectEnter: consistency info box obj->enter_object
  • onDrop: is “This doesn’t work in Global.” necessary or should it be on all functions
  • onDrop: info box description feels incomplete
  • onFlick: info box is broken
  • onPeek: “Called when a player using peek to look under an object” sounds weird
  • onPeek: consistency player->player_color and “Name of player color that” -> “Player color of the player who”
  • onPeek: an Object -> this Object
  • onPickUp: info box description feels incomplete
  • onPickUp: an Object -> this Object
  • onRandomize: an Object -> this Object
  • onSearchStart/End: info box description feels incomplete
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