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

Various missing functions/typos/consistency changes #128

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

Various missing functions/typos/consistency changes #128

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.

/atom

  • Code Autocompletion: “The entire Tabletop Simulator Lua Scripting API (with the exception of the Player class) has been added to the native Atom autocomplete system.”
    Player class is in there but a lot of other stuff is not, I have very slowly started working on this but I have not gotten far.

/intro/#left-column

  • Event -> Events

/intro/#guid

  • Custom Deck Card GUIDs -> instead of workshop tool maybe recommend spread in context menu and group?

/vr

  • Looks like it hasn’t been updated since v11.1, I wouldn’t even know where to start beyond copy and pasting from patch notes.

/base/#global-functions

  • clearContextMenu: consistency addContextMenuItem(...)
  • destroyObject: consistency obj->object

/base/#global-function-details

  • destroyObject: consistency obj->object

/base/#hotkey-function-details

  • addHotkey: consistency no other callback (that I have seen) lists the params inline ie. "callback(playerColor, hoveredObject, pointerPosition, isKeyUp):" -> "callback:", it is up to you which way to resolve as long as callbacks are consistent

/behavior/texttool

  • There are no examples to show you need to obj.TextTool to access functions anymore

/components/gameobject

  • All functions are duplicated in /object#component-functions unsure if this is by design

/hands

  • Should it link to the kb page on hand zones?

/info

  • Description talks about Hand Objects.

/player/instance

  • player.setUITheme(theme_script) is undocumented

/custom-game-objects#custom-token

  • Missing parameter stand_up (default false)

/timer

  • I would say Wait.time is closer than Wait.frames as it allows repetitions as a parameter

/ui/#inputs

  • value says it is unused by buttons but this is not true, it is either the mouse button that is clicked (“-1” to “-3”) or a string if they referenced the function like onClick=”myfunction(string_here)”

/ui/#function-details

  • setXmlTable: fails to render closing tag in value

/wait/#frames

  • Info box numberFrames -> frameCount (or vice versa as long as consistent with box header)

/webrequest/instance

  • response_code has no type currently, I think its an int

/webrequest/manager

  • A lot of the types.md tags do not link properly.
  • In all info boxes url could use better descriptiveness, post/put have typos anyway
  • custom: The URL to send a request to.
  • get: The URL to get data from.
  • post: The URL to post data to.
  • put: The URL to send data to.
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