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

Objects: missing functions/typos/consistency changes #126

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

Objects: missing functions/typos/consistency changes #126

corlick98 opened this issue Mar 20, 2021 · 0 comments

Comments

@corlick98
Copy link
Contributor

corlick98 commented Mar 20, 2021

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.

/object/#transform-functions

  • getNearestPointFromObject(other_object) is undocumented
  • getNearestPointFromPosition(position) is undocumented

/object/#action-function

  • #action-function -> #action-functions
  • randomize: consistency color->player_color

/object/#component-functions

  • getChildren: return table links to ../types.md which doesn’t exist
  • getComponentsInChildren: return table links to ../types.md which doesn’t exist

/object/#global-function

  • #global-function -> #global-functions
  • setTable: func_name -> table_name
  • setVar: func_name -> var_name

/object/#transform-function-details

  • should getBounds/getBoundsNormalized say they return a table of vectors instead of a table of tables?

/object/#action-function-details

  • unregisterCollisions has 3 dots like it has params but it doesn’t afaik
  • unregisterCollisions: info box is empty (pointless)

/object/#hide-function-details

  • All functions have the same consistency issues
  • (color_name) -> color_name (or player_color preferably)
  • Strings of the color name of each player. -> Player colors of the players the object should be hidden from. (or something similar)
  • If this is a typo in the API it should be fixed

/object/#global-function-details

  • call: should it mention that you can send other things than tables as long as it is a single value? If so then it should mention this
  • getDecals: position and rotation params say they are related to the object, are they not related to the image?
  • getSnapPoints: consistency, no other function lists its return like this, probably should look like setSnapPoints instead
  • setDecals: position and rotation params say they are related to the object, are they not related to the image?
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