TruWorlds

Classes (70)

Jump to ABCDEFGHILMNPSTVW

A

AssetKit AssetKit is a game system responsible for managing and loading game assets. Audio Audio is a DynamicInstance that can play either sound effect or music tracks Avatar Avatar is a <cref>PhysicsInstance</cref> that represents a player's character in the game world. AvatarAccessory AvatarAccessory is a wearable player item that can be parented to a <cref>Avatar</cref> instance to give the avatar cosmetics. AvatarAnimation AvatarAnimation defines a custom animation that can be applied to an Avatar instance. AvatarAnimator AvatarAnimator defines the animation state of a parent Avatar instance. It also provides standard animations for walking, running, jumping, and other locomotive actions. AvatarFace AvatarFace is a wearable player item that can be parented to a <cref>Avatar</cref> instance to give the avatar a custom face. AvatarItem Base class for avatar items that can be worn by an <cref>Avatar</cref> instance. AvatarPants AvatarPants is a wearable player item that can be parented to a <cref>Avatar</cref> instance to give the avatar custom pants. AvatarPoseNode AvatarShirt AvatarShirt is a wearable player item that can be parented to a <cref>Avatar</cref> instance to give the avatar a custom shirt. AvatarShoes AvatarShoes is a wearable player item that can be parented to a <cref>Avatar</cref> instance to give the avatar custom shoes. AvatarWeld AvatarWeld attaches a DynamicInstance to an Avatar with a local offset.

B

BaseLight BaseLight BaseSky BaseSky is an instance that represents the sky in the game world.

C

Camera Camera is an instance that represents a camera in the game world. CharacterController <cref>CharacterController</cref> is a special type of <cref>Model</cref> that provides standard platformer movement mechanics. ChatSystem ClickDetector ClickDetector allows player mouse interactions with a parent PhysicsInstance. ConeConstraint ConeJoint is a type of <cref>Constraint</cref> that connects two <cref>PhysicsInstance</cref> instances together such that they can rotate around a common point within a conical range of motion. Constraint Constraint is an instance that connects two <cref>PhysicsInstance</cref> instances together, allowing for constrained movement between them. CoreActions Stores built-in actions CoreUI Core client UI

D

DataModel DataModel is the root container for all instances in a TruWorlds game. DynamicInstance DynamicInstance is an Instance that has a position and rotation in the world, represented by a <cref>CMatrix</cref>.

E

EditorSystem System that controls features related to the TruWorlds Creator environment. Explosion Explosion is a transient instance that applies a radial impulse and optional visual effect.

F

FilterSystem Fire Fire is a persistent visual effect instance powered by a particle scene. Folder A generic instance container that can contain other instances.

G

GameSystem GameSystem is a base class for all core game systems in TruWorlds. Gizmo An instance that provides transformation controls

H

HingeConstraint HingeJoint is a type of <cref>Constraint</cref> that connects two <cref>PhysicsInstance</cref> instances together such that they can rotate around a single axis, similar to a door hinge. HttpKit HttpKit is a server-side game system that allows making external HTTP requests.

I

ImageSky ImageSky is a sky system that provides a configurable image-based skybox (from a cubemap or panoramic image). InputAction InputAction represents a specific user input action that can be triggered by an input InputSystem InputSystem is a client-side game system that provides input handling functionality. InsertSystem InsertSystem provides functionality for creating instances Instance Instance is the base type for all TruWorlds game objects.

L

Lighting Lighting is a game system that manages global lighting settings in the game world.

M

MeshPart MeshPart is a type of BasePart that displays a custom 3D mesh. Model Model is a special type of <cref>PhysicsInstance</cref> that can contain other <cref>PhysicsInstance</cref> instances as children. Physics instances parented to a Model will be joined together and move as a single unit. Motor Motor connects two <cref>PhysicsInstance</cref> instances and drives relative angular velocity between them around the axis defined by a face on the primary body.

N

Network Network is a game system that manages network-related settings and functionalities in the game world.

P

Part Parts are the fundamental building block of the TruWorlds game world. PhysicsInstance PhysicsBody is a dynamic instance that can be moved and interacted with in the game world. PinConstraint PinJoint is a type of <cref>Constraint</cref> that connects two <cref>PhysicsInstance</cref> instances together such that their position remains fixed relative to each other, but allows for rotation around the connection point. Player A player is a user client connected to the game server. Players Players is a game system that manages players connected to the server. PlayerStart An instance that marks the starting position of a player in the world. PointLight PointLight Proto Proto is an Instance that does not have any built-in behavior. It serves as a generic object that can be extended with TruScript to provide custom behavior.

S

ScriptSystem Seat Seat is a standard part that can be used for sitting. SelectionBox Displays a world-space BoundsBox in the world. SmartSky SmartSky is a sky system that provides a configurable procedural sky for the game world. SpeechBubble SpeechBubble is a DynamicInstance that displays a speech bubble. SpotLight SpotLight StarterPlayer StarterPlayer is a game system that defines default camera and character settings for playtesting. Storage Storage is a game system that can be used to place inactive instances. Surface Surface

T

TimeSystem TimeSystem is a game system that manages the passage of time. TouchListener An instance added as a child of PhysicsInstance that listens for touch events. It is added automatically when PhysicsInstance.Touched is subscribed to. TruWorldsObject

V

VehicleSeat VehicleSeat is a <cref>Seat</cref> that enables vehicle driving. When a player sits in a VehicleSeat, any <cref>Motor</cref> instances attached to parts that are welded to this seat (directly or transitively) are treated as drive wheels. Player forward/backward input is mapped to motor velocity and left/right input steers by inverting wheel motors on the opposing side. VisualInstance VisualInstance is an abstract base class for all instances that have both a physical and visual representation in the game world.

W

Weld Weld combines multiple physics instances into a single assembly. WeldConstraint WeldJoint is a type of <cref>Constraint</cref> that connects two <cref>PhysicsInstance</cref> instances together such that their position and rotation remain fixed relative to each other. World World is a game system that defines global properties of the game world. WorldSky WorldSky is a sky that displays a scene from the world.