More code blocks added to the documentation + some spelling/minor fixes #35
There are no files selected for viewing
This file contains 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
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: false | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: false | ||
| --- | ||
|
|
||
| # Characters |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| description: Changes a humanoid's state. | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: false | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # Change Humanoid State | ||
|
|
||
| ## Description | ||
|
|
||
| Changes a humanoid's state. | ||
|
|
||
| #### Available to | ||
|
|
||
| * [x] Scripts | ||
| * [x] LocalScripts | ||
| * [ ] Yields | ||
|
|
||
| ## Inputs | ||
|
|
||
| #### Humanoid (Object) | ||
|
|
||
| The humanoid whose state will be changed. | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| game.Workspace.ExampleChill.Humanoid | ||
| ``` | ||
|
|
||
| #### State (String) | ||
|
|
||
| The new state of the humanoid. For state names, check the [Enum.HumanoidStateType documentation.](https://create.roblox.com/docs/reference/engine/enums/HumanoidStateType) | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| FallingDown | ||
| ``` |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| description: Returns a bool based on whether or not if a tool is equipped. | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: false | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # Check Tool Equipped | ||
|
|
||
| ## Description | ||
|
|
||
| Returns a bool based on whether or not if a tool is equipped. | ||
|
|
||
| #### Available to | ||
|
|
||
| * [x] Scripts | ||
| * [x] LocalScripts | ||
| * [ ] Yields | ||
|
|
||
| ## Inputs | ||
|
|
||
| #### Tool (Object) | ||
|
|
||
| The tool whose equip status will be checked. | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| game.Players.ExampleGuy.LinkedSword | ||
| ``` | ||
|
|
||
| ## Outputs | ||
|
|
||
| #### Result (Bool) | ||
|
|
||
| Determines whether or not if the tool is equipped. | ||
|
|
||
| ``` | ||
| True | ||
| ``` |
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| description: Finds a path between the two positions. Returns a table of Vector3s, or a table with no elements if the path couldn't be computed. | ||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: false | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # Compute Path | ||
|
|
||
| ## Description | ||
|
|
||
| Finds a path between the two positions. Returns a table of Vector3s, or a table with no elements if the path couldn't be computed. | ||
|
There was a problem hiding this comment. This should match, or be part of the block description. |
||
|
|
||
| #### Available to | ||
|
|
||
| * [x] Scripts | ||
| * [x] LocalScripts | ||
| * [x] Yields | ||
|
|
||
| ## Inputs | ||
|
|
||
| #### StartPosition (Vector3) | ||
|
|
||
| The start position of the path. | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| 0, 100, 0 | ||
| ``` | ||
|
|
||
| #### EndPosition (Vector3) | ||
|
|
||
| The end position of the path. | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| 0, 0, 100 | ||
| ``` | ||
|
|
||
| ## Outputs | ||
|
|
||
| #### ComputedPath (Table) | ||
|
|
||
| The table of Vector3s that the path computed. *These are directly Vector3s, meaning you can loop through them and put their values in a position-based object property.* | ||
|
|
||
| ``` | ||
| {Vector3, Vector3, ...} | ||
| ``` | ||
This file contains 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 |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| description: Displays a colored chat bubble on a part object, with the specified message. | ||
|
There was a problem hiding this comment. This should match the block description. |
||
| layout: | ||
| title: | ||
| visible: true | ||
| description: | ||
| visible: false | ||
| tableOfContents: | ||
| visible: true | ||
| outline: | ||
| visible: true | ||
| pagination: | ||
| visible: true | ||
| --- | ||
|
|
||
| # Dialog Chat | ||
|
|
||
| ## Description | ||
|
|
||
| Displays a colored chat bubble on a part object, with the specified message. | ||
|
There was a problem hiding this comment. This should match the block description. |
||
|
|
||
| #### Available to | ||
|
|
||
| * [x] Scripts | ||
| * [x] LocalScripts | ||
| * [ ] Yields | ||
|
|
||
| ## Inputs | ||
|
|
||
| #### Part (Object) | ||
|
|
||
| The part that the bubble will adorn to. | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| game.Workspace.Cube | ||
| ``` | ||
|
|
||
| #### Message (String) | ||
|
|
||
| The message string that the bubble will display. | ||
|
|
||
| * [x] Can use Variable | ||
|
|
||
| ``` | ||
| I am very sentient! | ||
| ``` | ||
|
|
||
| #### Color (Choice) | ||
|
|
||
| The color of the chat bubble. | ||
|
|
||
| * [ ] Can use Variable | ||
|
|
||
| ``` | ||
| Red | ||
| ``` | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should match, or be part of the block description.