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

Consistency for tables in info boxes #129

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

Consistency for tables in info boxes #129

corlick98 opened this issue Mar 20, 2021 · 0 comments

Comments

@corlick98
Copy link
Contributor

Currently the API is inconsistent with how it presents tables inside !!!info boxes.
Some of them use:

  • parameters
    • parameters.value
    • parameters.subtable
      • parameters.subtable.value

and others use:

  • parameters
    • value
    • subtable
      • value

and others use:
Returns a table of sub-tables

  • value

The places that use the first are:
/events

  • onObjectCollisionEnter
  • onObjectCollisionExit
  • onObjectCollisionStay
  • onCollisionEnter
  • onCollisionExit
  • onCollisionStay

/base

  • paste
  • spawnObject
  • spawnObjectData
  • spawnObjectJSON

/object

  • createButton
  • createInput
  • editButton
  • editInput
  • clone
  • takeObject
  • addDecal
  • getDecals
  • setDecals

/notes

  • addNotebookTab
  • editNotebookTab

/physics

  • cast

/player/instance

  • attachCameraToObject
  • getHandTransform
  • lookAt
  • setHandTransform

/ui

  • setAttributes

The places that use the second are:
/objects

  • setFogOfWarReveal
  • setRotationValues
  • setHiddenFrom
  • setInvisibleTo
  • attachHider
  • attachInvisibleHider
  • setSnapPoints
  • setVectorLines

/musicplayer

  • getCurrentAudioClip
  • getPlaylist
  • setCurrentAudioClip
  • setPlaylist

/custom-game-objects

  • custom-assetbundle
  • custom-board
  • custom-deck
  • custom-dice
  • custom-figurine
  • custom-model
  • custom-tile
  • custom-token

/timer

  • create

/ui

  • getAttributes
  • getCustomAssets
  • setCustomAssets
  • setXmlTable

Places that use the third are:
/object

  • getRotationValues
  • getStates

Functions that use other formats include:
/object

  • getObjects
  • getSnapPoints

I feel a decision should be made to unify these into a single format. The first and second are about equally common so I am not sure which it should be.

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