Torque3D

https://docs.torque3d.org/
Admin
Torque3D is a comprehensive 3D game engine that provides tools and resources for creating games with...
Tokens:75,552
Snippets:1,203
Trust Score:9.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Torque3D ActionMap Setup and Keybinds

Source: https://docs.torque3d.org/for-designers/inputs/inputs-and-keybinds/actionmap

This example demonstrates how to create an ActionMap, define movement commands using bindCmd for both key press and release, and bind arrow keys using bind. It also shows how to enable the ActionMap and defines placeholder functions for movement logic.

```cpp
// Step 1: Create an ActionMap instance
if(!isObject(moveMap))
{
   new ActionMap(moveMap);
}

// Step 2: Define key commands
moveMap.bindCmd(keyboard, "w", "moveForward();", "moveStop();");
moveMap.bindCmd(keyboard, "a", "moveLeft();", "moveStop();");
moveMap.bindCmd(keyboard, "s", "moveBackward();", "moveStop();");
moveMap.bindCmd(keyboard, "d", "moveRight();", "moveStop();");

// Step 3: Add keybinds

// Binding the arrow keys for movement
moveMap.bind(keyboard, "up", "moveForward();");
moveMap.bind(keyboard, "down", "moveBackward();");
moveMap.bind(keyboard, "left", "moveLeft();");
moveMap.bind(keyboard, "right", "moveRight();");

// Step 4: Enable the ActionMap
moveMap.push();

// Game functions called as commands by the keybinds
function moveForward(%val) {
   // Logic to move the player forward
}

function moveBackward(%val) {
   // Logic to move the player backward
}

function moveLeft(%val) {
   // Logic to move the player left
}

function moveRight(%val) {
   // Logic to move the player right
}

function moveStop(%val) {
   // Logic to stop the player's movement
}
```

--------------------------------

### Install Template Files

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/compiling/compiling-in-linux

Use 'make install' to copy template files into your project folder. Note: This step is automated by CMake generation in versions post-4.0.3.

```bash
make install
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-designers/localization

Perform an HTTP GET request with the 'ask' query parameter to get dynamic answers and relevant excerpts from the documentation.

```http
GET https://docs.torque3d.org/for-designers/localization.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.torque3d.org/for-programmers/scripting/torquescript/objects

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic answers and relevant excerpts from the documentation.

```HTTP
GET https://docs.torque3d.org/for-programmers/scripting/torquescript/objects.md?ask=<question>
```

--------------------------------

### Handle Mission Start

Source: https://docs.torque3d.org/getting-started/getting-familiar/your-first-game/creating-an-empty-gamemode

This method is triggered when the mission starts, after it has finished loading. It prints a message to the console to confirm the mission has loaded.

```csharp
function CoinCollectionGameMode::onMissionStart(%this) {
    echo("CoinCollection mission has been loaded");
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-designers/scenes-and-levels/how-to-create-a-new-level

To get more information not present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-designers/scenes-and-levels/how-to-create-a-new-level.md?ask=<question>
```

--------------------------------

### Querying Documentation with GET Request

Source: https://docs.torque3d.org/for-designers/game-modes/making-a-level-use-your-gamemode

To get more information not present on the page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-designers/game-modes/making-a-level-use-your-gamemode.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query documentation. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.torque3d.org/for-artists/lighting

To get more information not present on this page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-artists/lighting.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/cmake

Perform an HTTP GET request to query the documentation dynamically. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/cmake.md?ask=<question>
```

--------------------------------

### Install Git on Ubuntu/Debian

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/downloading-git

Use this command to ensure you have the latest version of Git installed on Ubuntu or Debian-based Linux distributions.

```bash
sudo apt-get install git-all
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.torque3d.org/for-designers/scenes-and-levels/how-to-edit-levels/spawning-objects-from-the-asset-browser

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained. The response includes an answer and relevant documentation excerpts.

```http
GET https://docs.torque3d.org/for-designers/scenes-and-levels/how-to-edit-levels/spawning-objects-from-the-asset-browser.md?ask=<question>
```

--------------------------------

### Query Documentation with GET Request

Source: https://docs.torque3d.org/for-designers/ai

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```http
GET https://docs.torque3d.org/for-designers/ai.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-designers/modules/making-a-module-do-things

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic information. The question should be specific and self-contained.

```HTTP
GET https://docs.torque3d.org/for-designers/modules/making-a-module-do-things.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-designers/editors/changing-editor-settings

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections.

```http
GET https://docs.torque3d.org/for-designers/editors/changing-editor-settings.md?ask=<question>
```

--------------------------------

### Install Ubuntu Binaries for Torque3D

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/sdk-and-library-installation

Installs essential binary packages on Ubuntu, including git, build tools, NASM, Xorg development files, Ninja build system, and GCC multilib support.

```bash
sudo apt-get install git build-essential nasm xorg-dev 
sudo apt-get install ninja-build gcc-multilib g++-multilib 
sudo apt-get install cmake cmake-qt-gui
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-artists/audio

Perform an HTTP GET request on a documentation page URL with the `ask` query parameter to dynamically query for additional information. The question should be specific and self-contained. Use this mechanism when the answer is not explicitly present, for clarification, or to retrieve related documentation.

```http
GET https://docs.torque3d.org/for-artists/audio.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-artists/terrain

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get dynamic documentation answers. The question should be specific and in natural language.

```http
GET https://docs.torque3d.org/for-artists/terrain.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-programmers/networking/client-and-server-commands

To get additional information not directly on the page, perform an HTTP GET request to the current page URL with the 'ask' query parameter. The question should be specific and in natural language. Use this for clarification or to retrieve related documentation.

```http
GET https://docs.torque3d.org/for-programmers/networking/client-and-server-commands.md?ask=<question>
```

--------------------------------

### Install OpenSSL for Ubuntu libcurl Support

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/sdk-and-library-installation

Installs the OpenSSL development package on Ubuntu, necessary for libcurl support in Torque3D projects.

```bash
sudo apt-get install build-essential libssl-dev
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-artists/shapes/3d-art/blender-greater-than-torque3d-pipeline

Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and in natural language.

```http
GET https://docs.torque3d.org/for-artists/shapes/3d-art/blender-greater-than-torque3d-pipeline.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.torque3d.org/getting-started/getting-familiar/launching-the-game/opening-the-example-level

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information not directly available on the page. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/getting-started/getting-familiar/launching-the-game/opening-the-example-level.md?ask=<question>
```

--------------------------------

### Query Documentation with 'ask' Parameter

Source: https://docs.torque3d.org/for-artists/shapes/2d-art/working-with-adobe-substance

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language to get a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/for-artists/shapes/2d-art/working-with-adobe-substance.md?ask=<question>
```

--------------------------------

### Install Ubuntu Libraries for Torque3D

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/sdk-and-library-installation

Installs necessary development libraries on Ubuntu for Torque3D, including Ogg, Xft, X11, Xf86vm, OpenAL, FreeType, Xcursor, Xinerama, Xi, Xrandr, Xss, GLU, and GTK+ 3.

```bash
sudo apt-get install libogg-dev libxft-dev libx11-dev libxxf86vm-dev 
sudo apt-get install libopenal-dev libfreetype6-dev libxcursor-dev 
sudo apt-get install libxinerama-dev libxi-dev libxrandr-dev 
sudo apt-get install libxss-dev libglu1-mesa-dev libgtk-3-dev
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-artists/animation

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information not directly available on the page. The question should be specific and self-contained.

```HTTP
GET https://docs.torque3d.org/for-artists/animation.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://docs.torque3d.org/for-designers/editors/world-editor/navmesh-editor

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information not directly present on the page. The question should be specific and in natural language.

```http
GET https://docs.torque3d.org/for-designers/editors/world-editor/navmesh-editor.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/getting-started/getting-familiar/launching-the-game/launching-the-editors

Perform an HTTP GET request on the current page URL with the `ask` query parameter to get additional information not directly available on the page. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/getting-started/getting-familiar/launching-the-game/launching-the-editors.md?ask=<question>
```

--------------------------------

### File Header Comment Example

Source: https://docs.torque3d.org/for-programmers/code-style-guidelines

All files must begin with a File Header Comment containing copyright and licensing information.

```cpp
//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------
```

--------------------------------

### Calling Object Methods by Name and Handle

Source: https://docs.torque3d.org/for-programmers/scripting/torquescript/objects

Demonstrates how to invoke methods on an object using either its assigned name ('CistFan') or its unique handle stored in a variable ('$objID'). This example shows dumping object methods, getting an object's ID, and retrieving its position.

```clike
// Write all the objects methods to the console log
CistFan.dump();

// Get the ID of an object, using the object's name
$objID = CistFan.getID();

// Print the ID to the console
echo("Object ID: ", $objID);

// Get the object's position, using the object's handle
%position = $objID.getPosition();

// Print the position to the console
echo("Object Position: ", %position);
```

--------------------------------

### Build from Command Line

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/compiling/compiling-in-linux

Execute the build command in your project's root directory. The build process may take some time.

```bash
make
ninja
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.torque3d.org/for-designers/inputs/inputs-and-keybinds/bind-functions

To get additional information not directly on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-designers/inputs/inputs-and-keybinds/bind-functions.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/getting-started/getting-familiar/getting-a-copy/downloading-it-yourself

Perform an HTTP GET request to the current page URL with the `ask` query parameter to ask a question about the documentation. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/getting-started/getting-familiar/getting-a-copy/downloading-it-yourself.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-designers/modules/how-to-create-a-new-module

To get more information not present on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and in natural language.

```http
GET https://docs.torque3d.org/for-designers/modules/how-to-create-a-new-module.md?ask=<question>
```

--------------------------------

### Create Basic SimObject

Source: https://docs.torque3d.org/for-programmers/scripting/torquescript/objects

Creates a basic SimObject without any custom fields. The object can be referenced by the global variable $exampleSimObject.

```clike
// Create a SimObject without any name, argument, or fields.
$exampleSimObject = new SimObject();
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-programmers/collision

Use this method to ask questions about the documentation and receive direct answers with relevant excerpts. Perform an HTTP GET request on the page URL with the `ask` query parameter.

```HTTP
GET https://docs.torque3d.org/for-programmers/collision.md?ask=<question>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/for-artists/assets/deep-dive-creating-a-new-asset-type

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-artists/assets/deep-dive-creating-a-new-asset-type.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.torque3d.org/for-artists/gui/loading-and-initializing-a-gui

To get additional information not directly present on a page, perform an HTTP GET request to the current page URL with the `ask` query parameter. The question should be specific and self-contained.

```http
GET https://docs.torque3d.org/for-artists/gui/loading-and-initializing-a-gui.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/getting-started/getting-familiar/getting-ready-for-launch/running-pre-built-binaries

Use this method to ask questions about the documentation. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/getting-started/getting-familiar/getting-ready-for-launch/running-pre-built-binaries.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-programmers/major-components-of-the-engine/physics/stock-t3d-physics

Use this method to ask questions about the documentation. The question should be specific and self-contained. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/for-programmers/major-components-of-the-engine/physics/stock-t3d-physics.md?ask=<question>
```

--------------------------------

### Querying Documentation via HTTP GET

Source: https://docs.torque3d.org/for-programmers/major-components-of-the-engine/physics/physics-wrapper/physx

To get additional information not directly present on a page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/for-programmers/major-components-of-the-engine/physics/physics-wrapper/physx.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-programmers/major-components-of-the-engine/rendering/render-bins

Use this method to ask questions about the documentation. The question should be specific and self-contained. The response will include a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/for-programmers/major-components-of-the-engine/rendering/render-bins.md?ask=<question>
```

--------------------------------

### Module Initialization Script

Source: https://docs.torque3d.org/getting-started/porting-a-legacy-project

Basic script file for a module, containing functions to be called on module creation and destruction.

```C
function MyGame::onCreate( %this )
{
}

function MyGame::onDestroy( %this )
{
}
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.torque3d.org/getting-started/getting-familiar/deep-dive-basegame-directory-structure

To get additional information not directly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language. The response will include an answer and relevant excerpts.

```http
GET https://docs.torque3d.org/getting-started/getting-familiar/deep-dive-basegame-directory-structure.md?ask=<question>
```

--------------------------------

### Querying Action Map Documentation

Source: https://docs.torque3d.org/for-designers/inputs/inputs-and-keybinds/actionmap

Perform an HTTP GET request to query the documentation dynamically. Use the 'ask' query parameter with a specific, self-contained question in natural language.

```HTTP
GET https://docs.torque3d.org/for-designers/inputs/inputs-and-keybinds/actionmap.md?ask=<question>
```

--------------------------------

### Install GTK3 for Ubuntu File Dialogs

Source: https://docs.torque3d.org/for-programmers/compiling-the-engine/setup-development-environment/sdk-and-library-installation

Installs the GTK3 development package on Ubuntu, required for file dialog functionality in Torque3D.

```bash
sudo apt-get install build-essential libgtk-3-dev
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-designers/modules/installing-existing-modules/where-to-get-more-modules

Perform an HTTP GET request to the current page URL with the `ask` query parameter to retrieve specific information or clarifications from the documentation.

```HTTP
GET https://docs.torque3d.org/for-designers/modules/installing-existing-modules/where-to-get-more-modules.md?ask=<question>
```

--------------------------------

### Global and Local Function Declaration

Source: https://docs.torque3d.org/for-programmers/code-style-guidelines

Global functions start with a capital letter, while local (static) functions start with a lowercase letter.

```cpp
// good name for a global function
Time GetCurrentTime()
{
}

// good name for local (static) localfunction
static Interior & getNextInterior()
{
}
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-artists/materials/material-mapping

Perform an HTTP GET request to query documentation dynamically. Use the `ask` query parameter with a specific, self-contained question in natural language. The response will contain a direct answer and relevant excerpts.

```http
GET https://docs.torque3d.org/for-artists/materials/material-mapping.md?ask=<question>
```

--------------------------------

### Querying Documentation

Source: https://docs.torque3d.org/getting-started/getting-familiar/your-first-game/the-module-system

Demonstrates how to dynamically query Torque3D documentation by making an HTTP GET request with an 'ask' query parameter to a specific documentation page URL.

```http
GET https://docs.torque3d.org/getting-started/getting-familiar/your-first-game/the-module-system.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://docs.torque3d.org/for-programmers/file-inputs-outputs-i-o

Perform an HTTP GET request to query documentation dynamically with the `ask` query parameter. The question should be specific and self-contained. Use this mechanism when the answer is not explicitly present, you need clarification, or want to retrieve related documentation sections.

```http
GET https://docs.torque3d.org/for-programmers/file-inputs-outputs-i-o.md?ask=<question>
```

--------------------------------

### Example While Loop Termination in TorqueScript

Source: https://docs.torque3d.org/for-programmers/scripting/torquescript/control-structures

This example demonstrates a 'while' loop that continues as long as a counter is less than or equal to 5. The loop terminates once the condition is no longer met.

```TorqueScript
%countLimit = 0;

while(%countLimit <= 5)
{
   echo("Still in loop");
   %count++;
}

echo("Loop was terminated");
```

--------------------------------

### Local Variable Scope Example in TorqueScript

Source: https://docs.torque3d.org/for-programmers/scripting/torquescript/variables

This example demonstrates a local variable declared within a function. The variable '%userName' only exists and is accessible within the 'test()' function.

```clike
function test()
{
   %userName = "Heather";
   echo(%userName);
}
```

--------------------------------

### Declare Local and Global Variables in TorqueScript

Source: https://docs.torque3d.org/for-programmers/scripting/torquescript/variables

Local variables start with '%' and are scoped to specific code blocks. Global variables start with '$' and persist throughout the program's execution.

```clike
%localVariable = 1;
$globalVariable = 2;
```
Tokens:
Raw