-
Notifications
You must be signed in to change notification settings - Fork 42
Update documentation for 0.8 #97
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
Draft
scmcgowen
wants to merge
5
commits into
IntelligenceModding:0.8
Choose a base branch
from
scmcgowen:0.8
base: 0.8
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
6dd60ae
Add updateBlock to Weak Automata
scmcgowen 09c023a
Add options for the look at methods
scmcgowen dafe6fe
Merge branch 'IntelligenceModding:0.8' into 0.8
scmcgowen 364b12c
Make options show as optional
scmcgowen 84579c7
Add Default column
scmcgowen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -95,23 +95,38 @@ Returns the configuration values for this automata. | |
|
|
||
| ### lookAtBlock | ||
| ``` | ||
| lookAtBlock() -> table | nil, string | ||
| lookAtBlock(options: table) -> table | nil, string | ||
| ``` | ||
| Returns a table containing information about the block infront of the turtle or if the operation fails it will return nil and an error message. | ||
|
|
||
| #### `options` properties | ||
|
|
||
| | name | type | Description | | ||
| | ----- | --------------- | ------------------------------------------------------------------------------------------------ | | ||
| | pitch | `number | nil` | Relative pitch degrees, negative means to turn left, positive means to turn right (default: `0`) | | ||
|
||
| | yaw | `number | nil` | Relative yaw degrees, negative means to look up, positive means to look down (default: `0`) | | ||
|
|
||
| --- | ||
|
|
||
| ### lookAtEntity | ||
| ``` | ||
| lookAtEntity() -> table | nil, string | ||
| lookAtEntity(options: table) -> table | nil, string | ||
| ``` | ||
| Returns a table containing information about the entity infront of the turtle or if the operation fails it will return nil and an error message. | ||
|
|
||
|
|
||
| #### `options` properties | ||
|
|
||
| | name | type | Description | | ||
| | ----- | --------------- | ------------------------------------------------------------------------------------------------ | | ||
| | pitch | `number | nil` | Relative pitch degrees, negative means to turn left, positive means to turn right (default: `0`) | | ||
| | yaw | `number | nil` | Relative yaw degrees, negative means to look up, positive means to look down (default: `0`) | | ||
|
|
||
| --- | ||
|
|
||
| ### digBlock | ||
| ``` | ||
| digBlock(options: table | nil) -> true | nil, string | ||
| digBlock(options: table | nil) -> boolean, string | ||
| ``` | ||
| Tries to dig the block that the turtle is looking at with the current item. It returns true if it successfully mines the block or nil and an error message. | ||
|
|
||
|
|
@@ -127,7 +142,7 @@ Tries to dig the block that the turtle is looking at with the current item. It r | |
|
|
||
| ### useOnBlock | ||
| ``` | ||
| useOnBlock(options: table | nil) -> true | nil, string | ||
| useOnBlock(options: table | nil) -> boolean, string | ||
| ``` | ||
| Tries to interact with the block that the turtle is looking at with the current item. It returns true if it successfully interacts with the block or nil and an error message. | ||
|
|
||
|
|
@@ -141,6 +156,22 @@ Tries to interact with the block that the turtle is looking at with the current | |
|
|
||
| --- | ||
|
|
||
| ### updateBlock | ||
| ``` | ||
| updateBlock(options: table) -> boolean, string | ||
| ``` | ||
| Tries to update the text of the sign that the turtle is looking at with the `options.text` property | ||
|
|
||
| #### `options` properties | ||
|
|
||
| | name | type | Description | | ||
| | ----- | --------------- | ------------------------------------------------------------------------------------------------ | | ||
| | pitch | `number | nil` | Relative pitch degrees, negative means to turn left, positive means to turn right (default: `0`) | | ||
| | yaw | `number | nil` | Relative yaw degrees, negative means to look up, positive means to look down (default: `0`) | | ||
| | text | `string` | The text to apply to the sign | | ||
|
|
||
| --- | ||
|
|
||
| ### scanItems | ||
| ``` | ||
| scanItems() -> table | nil, string | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.