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

Computercraft/OpenComputers is missing documentation for some blocks #495

Open
razvii22 opened this issue Jul 22, 2021 · 3 comments
Open
Milestone

Comments

@razvii22
Copy link

Some blocks that interact with CC or OC have absolutely no documentation(that i can find) for some of their methods.
Such as the Environmental scanner's getAtmosphere() method which just returns 2 booleans and an int, of which i managed to figure out that the second one reports air(?) presence.
image
Or the Biometric scanner's getScanResults() which returns a boolean, a nil and the name of the player, true indicating whether the scan was successful or not, but what is the nil value supposed to indicate?
image
And a fair bit more but those are from the top of my head.
I suggest these blocks should have their methods and the documentation of said methods on either the wiki or the ingame book.

@LemADEC
Copy link
Owner

LemADEC commented Jul 22, 2021

Environmental sensor comes with a preloaded script that gives the returned values names, should be fairly explicit. There's a pinned message on the official discord with the details.

@LemADEC LemADEC added this to the Wiki milestone Jul 22, 2021
@razvii22
Copy link
Author

Must've missed the script being preloaded since it doesnt start on startup like others, my bad, still some extensive documentation would be great in the future.
Alternatively implementing the getDocs() method as some other peripherals from other mods have, would also work wonders.
image

@LemADEC
Copy link
Owner

LemADEC commented Jan 15, 2022

We've tried the an help or getDocs in the past but it doesn't work when we've so many methods available. A proper IDE would make more sense or maybe a dumped help file in a shared folder

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

No branches or pull requests

2 participants