Skip to content
This repository has been archived by the owner on Jul 25, 2021. It is now read-only.

Facelift the built-in objects page #36

Open
wants to merge 62 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
62 commits
Select commit Hold shift + click to select a range
d730ec3
Fix typo in types.md
Jun 28, 2019
b8336ec
Added required "name" attribute for Save&Play
rolandostar Jun 30, 2019
9a9c4df
Update intro.md
greenanvil Dec 28, 2019
86c1d4e
Fix code snippet for #getValue
BreadMoirai Feb 26, 2020
9b27c98
Update attributes.md
Rylern Mar 19, 2020
5304aa6
Proof Edits
chcantre Apr 8, 2020
13f2cb7
Updating Atom Documentation for opening Console
Seferan Apr 10, 2020
13749ee
Update intro.md
exanthis Apr 14, 2020
f3c29f4
added missing fill-related attributes
nabbydude Apr 21, 2020
5c1d7f8
added missing text attributes
nabbydude Apr 21, 2020
d48f45c
Merge pull request #1 from tts-community/master
nabbydude Apr 22, 2020
c15131d
added missing general and tooltip attributes
nabbydude Apr 22, 2020
d431f3f
deleted conflicting CNAME
nabbydude Apr 22, 2020
31cd570
added .vscode/ to gitignore
nabbydude Apr 22, 2020
cd0be91
Revert "added missing fill-related attributes"
nabbydude Apr 22, 2020
582be4b
Revert "added missing text attributes"
nabbydude Apr 22, 2020
307e538
Revert "added missing general and tooltip attributes"
nabbydude Apr 22, 2020
b750ab3
Merge remote-tracking branch 'tts-community/master'
nabbydude May 1, 2020
82e0c95
Merge https://github.com/tts-community/api
nabbydude May 2, 2020
1409a9d
facelifted the built-in objects page
nabbydude May 2, 2020
af45a2d
added site_url to fix broken 404
nabbydude May 4, 2020
6cf7dc1
Merge pull request #49 from michaelmcleodnz/patch-1
Knils May 12, 2020
b2cc7c9
Merge pull request #50 from flocker1/master
Knils May 12, 2020
e5408c2
Merge pull request #48 from Seferan/patch-1
Knils May 12, 2020
b3e9c7b
Merge pull request #33 from mathfreak231/patch-1
Knils May 12, 2020
4b9ca68
Merge pull request #34 from rolandostar/rolandostar-patch-1
Knils May 12, 2020
fa78c8f
Merge pull request #42 from BreadMoirai/patch-1
Knils May 12, 2020
e38b1a4
Merge pull request #44 from Rylern/patch-1
Knils May 12, 2020
5a4d3db
Merge pull request #47 from chcantre/patch-1
Knils May 12, 2020
3845c2b
Merge pull request #39 from greenanvil/patch-1
Knils May 12, 2020
1d5a6c9
Github Action to deploy to Github Pages
Benjamin-Dobell Apr 21, 2020
e8eaf2f
Bumped dependencies in particular markupsafe
Benjamin-Dobell Apr 21, 2020
44fb8e6
Adding Vector documentation
Zehir Apr 21, 2020
27a64d0
Update Element access summary description
Zehir Apr 22, 2020
c283513
Adding self type tag
Zehir Apr 22, 2020
55b590b
Update Vector doc format
Zehir Apr 22, 2020
d6e4999
changed link format to be mkdocs-compliant
nabbydude Apr 26, 2020
0fef033
Update object.md
Eldinnie Apr 26, 2020
8b45999
Adding Color class doc
Zehir Apr 26, 2020
5664e62
Update mkdocs.yml
Zehir Apr 26, 2020
89c9e39
fixed function signature for group()
omniraptorr Apr 27, 2020
a603f04
onObjectCollision* events
Benjamin-Dobell Apr 26, 2020
4864d3b
Update Unity doc links
Zehir Apr 28, 2020
cf5534c
Patch 12.3 (tts-community/api#18)
omniraptorr Apr 29, 2020
2da9e81
Reorder to match ingame
Zehir Apr 29, 2020
9ff4089
The name property is not the same as getName()
Benjamin-Dobell Apr 30, 2020
6169ab4
More verbose description for object.name
Benjamin-Dobell Apr 30, 2020
8f862bc
fixes issue tts-community/api#20. credit to discord user Thelo#0327
omniraptorr Apr 30, 2020
008180f
added infobox about y-alignment of decks in putObject(). see issue tt…
omniraptorr May 1, 2020
7599bad
Split Spawnable Objects page
Zehir May 1, 2020
852e0a0
Update object.md (tts-community/api#40)
Eldinnie May 3, 2020
d19e29c
spawnObjectJSON() does not use sound or snap_to_grid
Benjamin-Dobell May 6, 2020
95ef727
Fix getPointerRotation return
Zehir May 6, 2020
e54c9f7
Replacing change-log page to patch-note page (tts-community/api#35)
Zehir May 6, 2020
c291b21
motor_free_spin not motor_freeSpin
Benjamin-Dobell May 13, 2020
b7bf06e
added details for filterObjectEnterContainer
omniraptorr May 16, 2020
9008b1c
Object#drag_selectable is now persisted
Benjamin-Dobell Jun 3, 2020
07d3ab2
added a spawnable names category + some fixes
nabbydude Jun 7, 2020
a4b20af
merged official repo
nabbydude Jun 7, 2020
ad12270
reorganized and added explanations
nabbydude Jan 31, 2021
f5ca35d
Merge branch 'master' into spawnable-object-descriptions
nabbydude Jan 31, 2021
1907706
cleaning dirty files before PR
nabbydude Jan 31, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
uses: actions/cache@v1
with:
path: ~/.local/share/virtualenvs
key: ${{ runner.os }}-venv-${{ hashFiles('**/Pipfile.lock') }}
key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}

- name: Install dependencies
if: steps.cache-dependencies.outputs.cache-hit != 'true'
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
site/
mkdocs/
mkdocs/
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
api.tabletopsimulator.com
4 changes: 2 additions & 2 deletions docs/atom.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ The plugin will automatically check for updates when Atom is started. If a new u
These are just a few basic tips to help get the most out of Atom.

* Print Messages
* All print() functions automatically send their messages to Atom's console (ctrl + alt + i).
* All print() functions automatically send their messages to Atom's console (ctrl + shift + i).
* Error Messages
* All Lua errors are automatically sent to Atom's console (ctrl + alt + i).
* All Lua errors are automatically sent to Atom's console (ctrl + shift + i).
* Quick Save + Play
* Hitting Ctrl + Shift + S will trigger Save & Play.
10 changes: 3 additions & 7 deletions docs/base.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ getObjectFromGUID([<span class="tag str"></span>](types.md)&nbsp;guid) | Returns
group([<span class="tag tab"></span>](types.md)&nbsp;objects) | Groups objects together, like how the `G` key does for players. | [<span class="ret tab"></span>](types.md) | [<span class="i"></span>](#group)
paste([<span class="tag tab"></span>](types.md)&nbsp;parameters) | Pastes Objects in-game that were copied to the in-game clipboard. Works with [copy(...)](#copy). | [<span class="ret tab"></span>](types.md) | [<span class="i"></span>](#paste)
<a class="anchor" id="setlookingforplayers"></a>setLookingForPlayers([<span class="tag boo"></span>](types.md)&nbsp;lfp) | Enables/disables looking for group. This is visible in the server browsers, indicating if you are recruiting for a game. | [<span class="ret boo"></span>](types.md) |
spawnObject([<span class="tag tab"></span>](types.md)&nbsp;parameters) | Spawns an Object. View the [Spawnable Object](spawnableobjects.md) page for Objects that can be spawned. | [<span class="ret obj"></span>](types.md) | [<span class="i"></span>](#spawnobject)
spawnObject([<span class="tag tab"></span>](types.md)&nbsp;parameters) | Spawns an Object. See [Built-in](built-in-object.md) and [Custom](custom-game-objects.md) Spawnable Object pages for further details. | [<span class="ret obj"></span>](types.md) | [<span class="i"></span>](#spawnobject)
spawnObjectJSON([<span class="tag tab"></span>](types.md)&nbsp;parameters) | Spawns an Object using a JSON string. Works with [getJSON()](object.md#getjson). | [<span class="ret obj"></span>](types.md) | [<span class="i"></span>](#spawnobjectjson)
startLuaCoroutine([<span class="tag obj"></span>](types.md)&nbsp;function_owner, [<span class="tag str"></span>](types.md)&nbsp;function_name) | Start a coroutine. | [<span class="ret boo"></span>](types.md) | [<span class="i"></span>](#startluacoroutine)
stringColorToRGB([<span class="tag str"></span>](types.md)&nbsp;player_color) | Converts a [Player Color](player-color.md) string into a Color Table for tinting. | [<span class="ret col"></span>](types.md#color) | [<span class="i"></span>](#stringcolortorgb)
Expand Down Expand Up @@ -130,7 +130,7 @@ end

####spawnObject(...)

[<span class="ret obj"></span>](types.md)&nbsp;Spawn an Object. View the [Spawnable Objects](spawnableobjects.md) page for Objects that can be spawned.
[<span class="ret obj"></span>](types.md)&nbsp;Spawns an Object. See [Built-in](built-in-object.md) and [Custom](custom-game-objects.md) Spawnable Objects pages for details of specific spawnable objects.

If you are spawning a **custom Object**, you should call [setCustomObject](object.md#setcustomobject) immediately after spawnObject to set its custom properties.

Expand All @@ -139,7 +139,7 @@ If you are spawning a **custom Object**, you should call [setCustomObject](objec

!!!info "spawnObject(parameters)"
* [<span class="tag tab"></span>](types.md) **parameters**: A Table of parameters used to determine how spawnObject will act.
* [<span class="tag str"></span>](types.md) **parameters.type**: [Spawnable Object](spawnableobjects.md) type.
* [<span class="tag str"></span>](types.md) **parameters.type**: [Built-in](built-in-object.md) or [Custom](custom-game-objects.md) Game Object name.
* [<span class="tag vec"></span>](types.md#vector) **parameters.position**: Position to place Object.
* {>>Optional, defaults to {x=0, y=3, z=0}.<<}
* [<span class="tag vec"></span>](types.md#vector) **parameters.rotation**: Rotation of the Object.
Expand Down Expand Up @@ -197,10 +197,6 @@ Spawns an Object using a JSON string. Works with [getJSON()](object.md#getjson).
* {>>Optional, defaults to JSON's value.<<}
* [<span class="tag vec"></span>](types.md#vector) **parameters.scale**: Scale of the Object.
* {>>Optional, defaults to JSON's value.<<}
* [<span class="tag boo"></span>](types.md) **parameters.sound**: If the spawned Object noise is played.
* {>>Optional, defaults to JSON's value.<<}
* [<span class="tag boo"></span>](types.md) **parameters.snap_to_grid**: If snap-to-grid is active on the Object.
* {>>Optional, defaults to JSON's value.<<}
* [<span class="tag fun"></span>](types.md#function) **parameters.callback_function**: The function to activate after the Object has finished spawning into the scene.
* {>>Optional, defaults to not being used.<<}
* {>>A reference to the object spawned is always passed to callback_function. See the example for how to access it.<<}
Expand Down
Loading