Torque 3D - Script Manual: Prefab Class Reference

TorqueScript

Main   Class List   Namespace List   Online

Prefab Class Reference
[Miscellaneous]

A collection of arbitrary objects which can be allocated and manipulated as a group. More...

Inheritance diagram for Prefab:

List of all members.

Public Member Functions

Callbacks

void onLoad (SimGroup children)
 Called when the prefab file is loaded and children objects are created.

Public Attributes

Prefab

filename fileName
 (.prefab) File describing objects within this prefab.

Static Public Attributes

static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.

Detailed Description

A collection of arbitrary objects which can be allocated and manipulated as a group.

Prefab always points to a (.prefab) file which defines its objects. In fact more than one Prefab can reference this file and both will update if the file is modified.

Prefab is a very simple object and only exists on the server. When it is created it allocates children objects by reading the (.prefab) file like a list of instructions. It then sets their transform relative to the Prefab and Torque networking handles the rest by ghosting the new objects to clients. Prefab itself is not ghosted.


Member Function Documentation

void Prefab::onLoad ( SimGroup  children  ) 

Called when the prefab file is loaded and children objects are created.

Parameters:
children SimGroup containing all children objects.

Member Data Documentation

filename Prefab::fileName

(.prefab) File describing objects within this prefab.



Copyright © GarageGames, LLC. All Rights Reserved.