Jump to content
  • Sky
  • Blueberry
  • Slate
  • Blackcurrant
  • Watermelon
  • Strawberry
  • Orange
  • Banana
  • Apple
  • Emerald
  • Chocolate
  • Charcoal

Archived

This topic is now archived and is closed to further replies.

TwoThe

Will there be an update to the wiki?

Recommended Posts

Because either I am completely missing something or it is heavily outdated.

 

Just started with OpenComputers and it took me a while to figure out why most of the documented functions just weren't working. Turned out the documentation is just plain wrong.

 

Example:

Wiki:

robot.forward()
Actually:

robot.move(sides.forward)
I don't mind the code update, but without a proper documentation there is hardly anyone going to use this mod.

Share this post


Link to post
Share on other sites

Take care not to mix up the robot component with the robot library. What's documented on the wiki is the library, which is used like `robot.forward()`. It only wraps the component to make it nicer to work with. You can always also do `component.robot.move(sides.forward)`, if you really want to (or it makes some code easier to generify).

Share this post


Link to post
Share on other sites

This is very confusing... so there is a robot API and a robot API, both do the same, but they are different?

Have I mentioned that the documentation could use some clarification? ;)

Share this post


Link to post
Share on other sites

Hi,

 

I logged into the wiki to clarify sangar's point - as the robot api page pre-amble is a little out of date, or perhaps unclear, but I don't seem to be able to edit that page  :/

 

any reason why Sangar ?

Share this post


Link to post
Share on other sites

... i was being a derp anyway, i was looking for the edit button which was on some of the pages, hadn't seen the pull-down option for it :)

Share this post


Link to post
Share on other sites

i've updated that page, TwoThe

 

http://ocdoc.cil.li/api:robot

 

i've added a paragraph at the top which goes some way to describing the difference... it's perhaps not as clear as it could be, but to make it any clearer it really would need a whole new page adding in the components section for the robot's lower level component api and linking to that instead... but that seems like overkill - and hopefully the way i've described the differences for the few cases i've detailed explains the other cases one might encounter. 

Share this post


Link to post
Share on other sites

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use and Privacy Policy.