consoleTypes.h

Public User Defined

DefineConsoleType(TypeBool , bool )

DefineConsoleType(TypeBoolVector , Vector< bool > )

DefineConsoleType(TypeColorF , ColorF )

DefineConsoleType(TypeColorI , ColorI )

DefineConsoleType(TypeCommand , String )

DefineConsoleType(TypeCubemapName , String )

DefineConsoleType(TypeF32 , F32 )

DefineConsoleType(TypeF32Vector , Vector< F32 > )

DefineConsoleType(TypeFilename , const char * )

DefineConsoleType(TypeFlag , S32 )

DefineConsoleType(TypeImageFilename , String )

DefineConsoleType(TypeMaterialName , String )

DefineConsoleType(TypeName , const char * )

DefineConsoleType(TypeParticleParameterString , const char * )

DefineConsoleType(TypePrefabFilename , String )

const char *

DefineConsoleType(TypeRealString , String )

DefineConsoleType(TypeRectUV , RectF )

DefineConsoleType(TypeRotationF , RotationF )

DefineConsoleType(TypeS32 , S32 )

DefineConsoleType(TypeS32Vector , Vector< S32 > )

DefineConsoleType(TypeS8 , S8 )

DefineConsoleType(TypeShader , GFXShader * )

DefineConsoleType(TypeShapeFilename , String )

DefineConsoleType(TypeSimObjectName , SimObject * )

DefineConsoleType(TypeSimObjectPtr , SimObject * )

DefineConsoleType(TypeSimPersistId , SimPersistID * )

DefineConsoleType(TypeStringFilename , String )

DefineConsoleType(TypeTerrainMaterialIndex , S32 )

DefineConsoleType(TypeTerrainMaterialName , const char * )

DefineConsoleType(TypeUUID , Torque::UUID )

DefineUnmappedConsoleType(TypePID , SimPersistID * )

DefineUnmappedConsoleType(TypeString , const char * )

Offset(x, cls) offsetof(cls, x)

Public User Defined

DefineConsoleType(TypeBool , bool )

DefineConsoleType(TypeBoolVector , Vector< bool > )

DefineConsoleType(TypeColorF , ColorF )

DefineConsoleType(TypeColorI , ColorI )

DefineConsoleType(TypeCommand , String )

DefineConsoleType(TypeCubemapName , String )

TypeCubemapName is equivalent to TypeRealString in its usage, but the Inspector will provide a drop-down list of CubemapData objects.

DefineConsoleType(TypeF32 , F32 )

DefineConsoleType(TypeF32Vector , Vector< F32 > )

DefineConsoleType(TypeFilename , const char * )

DefineConsoleType(TypeFlag , S32 )

DefineConsoleType(TypeImageFilename , String )

TypeImageFilename is equivalent to TypeStringFilename in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type that can display a texture preview.

DefineConsoleType(TypeMaterialName , String )

TypeMaterialName is equivalent to TypeRealString in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type.

DefineConsoleType(TypeName , const char * )

Special field type for SimObject::objectName.

DefineConsoleType(TypeParticleParameterString , const char * )

DefineConsoleType(TypePrefabFilename , String )

TypePrefabFilename is equivalent to TypeStringFilename in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type.

DefineConsoleType(TypeRealString , String )

DefineConsoleType(TypeRectUV , RectF )

TypeRectUV is equivalent to TypeRectF in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type.

DefineConsoleType(TypeRotationF , RotationF )

DefineConsoleType(TypeS32 , S32 )

DefineConsoleType(TypeS32Vector , Vector< S32 > )

DefineConsoleType(TypeS8 , S8 )

DefineConsoleType(TypeShader , GFXShader * )

DefineConsoleType(TypeShapeFilename , String )

TypeShapeFilename is equivalent to TypeStringFilename in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type.

DefineConsoleType(TypeSimObjectName , SimObject * )

DefineConsoleType(TypeSimObjectPtr , SimObject * )

DefineConsoleType(TypeSimPersistId , SimPersistID * )

A persistent reference to an object.

This reference indirectly goes through the referenced object's persistent ID.

DefineConsoleType(TypeStringFilename , String )

DefineConsoleType(TypeTerrainMaterialIndex , S32 )

TypeTerrainMaterialIndex is equivalent to TypeS32 in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type.

DefineConsoleType(TypeTerrainMaterialName , const char * )

TypeTerrainMaterialName is equivalent to TypeString in its usage, it exists for the benefit of GuiInspector, which will provide a custom InspectorField for this type.

DefineConsoleType(TypeUUID , Torque::UUID )

A universally unique identifier.

DefineUnmappedConsoleType(TypePID , SimPersistID * )

A persistent ID that is associated with an object.

This type cannot be used to reference PIDs of other objects.

DefineUnmappedConsoleType(TypeString , const char * )

Offset(x, cls) offsetof(cls, x)

  1
  2//-----------------------------------------------------------------------------
  3// Copyright (c) 2012 GarageGames, LLC
  4//
  5// Permission is hereby granted, free of charge, to any person obtaining a copy
  6// of this software and associated documentation files (the "Software"), to
  7// deal in the Software without restriction, including without limitation the
  8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  9// sell copies of the Software, and to permit persons to whom the Software is
 10// furnished to do so, subject to the following conditions:
 11//
 12// The above copyright notice and this permission notice shall be included in
 13// all copies or substantial portions of the Software.
 14//
 15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 21// IN THE SOFTWARE.
 22//-----------------------------------------------------------------------------
 23
 24#ifndef _CONSOLETYPES_H_
 25#define _CONSOLETYPES_H_
 26
 27#ifndef _DYNAMIC_CONSOLETYPES_H_
 28#include "console/dynamicTypes.h"
 29#endif
 30
 31#ifndef _MATHTYPES_H_
 32#include "math/mathTypes.h"
 33#endif
 34
 35#ifndef _ENGINEPRIMITIVES_H_
 36#include "console/enginePrimitives.h"
 37#endif
 38
 39#ifndef _ENGINESTRUCTS_H_
 40#include "console/engineStructs.h"
 41#endif
 42
 43
 44/// @file
 45/// Legacy TS-based console type definitions.
 46
 47
 48/// @ingroup console_system Console System
 49/// @{
 50
 51#ifndef Offset
 52#define Offset(x, cls) offsetof(cls, x)
 53#endif
 54
 55class GFXShader;
 56class GFXCubemap;
 57class CustomMaterial;
 58class ProjectileData;
 59class ParticleEmitterData;
 60class SimPersistID;
 61
 62
 63// Define Core Console Types
 64DefineConsoleType( TypeBool, bool )
 65DefineConsoleType( TypeBoolVector, Vector<bool>)
 66DefineConsoleType( TypeS8,  S8 )
 67DefineConsoleType( TypeS32, S32 )
 68DefineConsoleType( TypeS32Vector, Vector<S32> )
 69DefineConsoleType( TypeF32, F32 )
 70DefineConsoleType( TypeF32Vector, Vector<F32> )
 71DefineUnmappedConsoleType( TypeString, const char * ) // plain UTF-8 strings are not supported in new interop
 72DefineConsoleType( TypeCaseString, const char * )
 73DefineConsoleType( TypeRealString, String )
 74DefineConsoleType( TypeCommand, String )
 75DefineConsoleType( TypeFilename, const char * )
 76DefineConsoleType( TypeStringFilename, String )
 77
 78DefineConsoleType(TypeRotationF, RotationF)
 79
 80/// A universally unique identifier.
 81DefineConsoleType( TypeUUID, Torque::UUID )
 82
 83/// A persistent ID that is associated with an object.  This type cannot
 84/// be used to reference PIDs of other objects.
 85DefineUnmappedConsoleType( TypePID, SimPersistID* );
 86
 87/// TypeImageFilename is equivalent to TypeStringFilename in its usage,
 88/// it exists for the benefit of GuiInspector, which will provide a custom
 89/// InspectorField for this type that can display a texture preview.
 90DefineConsoleType( TypeImageFilename, String )
 91
 92/// TypePrefabFilename is equivalent to TypeStringFilename in its usage,
 93/// it exists for the benefit of GuiInspector, which will provide a 
 94/// custom InspectorField for this type.
 95DefineConsoleType( TypePrefabFilename, String )
 96
 97/// TypeShapeFilename is equivalent to TypeStringFilename in its usage,
 98/// it exists for the benefit of GuiInspector, which will provide a 
 99/// custom InspectorField for this type.
100DefineConsoleType( TypeShapeFilename, String )
101
102/// TypeMaterialName is equivalent to TypeRealString in its usage,
103/// it exists for the benefit of GuiInspector, which will provide a 
104/// custom InspectorField for this type.
105DefineConsoleType( TypeMaterialName, String )
106
107/// TypeTerrainMaterialIndex is equivalent to TypeS32 in its usage,
108/// it exists for the benefit of GuiInspector, which will provide a 
109/// custom InspectorField for this type.
110DefineConsoleType( TypeTerrainMaterialIndex, S32 )
111
112/// TypeTerrainMaterialName is equivalent to TypeString in its usage,
113/// it exists for the benefit of GuiInspector, which will provide a 
114/// custom InspectorField for this type.
115DefineConsoleType( TypeTerrainMaterialName, const char * )
116
117/// TypeCubemapName is equivalent to TypeRealString in its usage,
118/// but the Inspector will provide a drop-down list of CubemapData objects.
119DefineConsoleType( TypeCubemapName, String )
120
121DefineConsoleType( TypeParticleParameterString, const char * )
122
123DefineConsoleType( TypeFlag, S32 )
124DefineConsoleType( TypeColorI, ColorI )
125DefineConsoleType( TypeColorF, ColorF )
126DefineConsoleType( TypeSimObjectName, SimObject* )
127DefineConsoleType( TypeShader, GFXShader * )
128
129DefineConsoleType(TypeSimObjectPtr, SimObject*)
130
131/// A persistent reference to an object.  This reference indirectly goes
132/// through the referenced object's persistent ID.
133DefineConsoleType( TypeSimPersistId, SimPersistID* )
134
135/// Special field type for SimObject::objectName
136DefineConsoleType( TypeName, const char* )
137
138/// TypeRectUV is equivalent to TypeRectF in its usage,
139/// it exists for the benefit of GuiInspector, which will provide a 
140/// custom InspectorField for this type.
141DefineConsoleType( TypeRectUV, RectF )
142
143/// @}
144
145#endif
146