This repository was archived by the owner on Jul 25, 2021. It is now read-only.

Facelift the built-in objects page #36

Open

nabbydude wants to merge 62 commits into tts-community:master from nabbydude:spawnable-object-descriptions

.github/workflows/mkdocs.yml

-Original file 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 @@

.gitignore

-Original file line number
+Diff line change
@@ -1,2 +1,2 @@
     site/
-    mkdocs/
+    mkdocs/

docs/CNAME

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		api.tabletopsimulator.com

docs/atom.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -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.

docs/base.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -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)

    @@ -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.

    @@ -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.

    @@ -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.<<}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Facelift the built-in objects page #36

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Facelift the built-in objects page #36

Are you sure you want to change the base?

Uh oh!

Facelift the built-in objects page #36

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!