consoleTypes.h

Public Functions

nullAsType()

  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
 43template<typename T> inline const T nullAsType(){ return nullptr; }
 44
 45/// @file
 46/// Legacy TS-based console type definitions.
 47
 48
 49/// @ingroup console_system Console System
 50/// @{
 51
 52#ifndef Offset
 53#define Offset(x, cls) offsetof(cls, x)
 54#endif
 55
 56class GFXShader;
 57class GFXCubemap;
 58class CustomMaterial;
 59class ProjectileData;
 60class ParticleEmitterData;
 61class SimPersistID;
 62
 63
 64// Define Core Console Types
 65DefineConsoleType( TypeBool, bool )
 66DefineConsoleType( TypeBoolVector, Vector<bool>)
 67DefineConsoleType( TypeS8,  S8 )
 68DefineConsoleType( TypeS32, S32 )
 69DefineConsoleType( TypeS32Vector, Vector<S32> )
 70DefineConsoleType( TypeF32, F32 )
 71DefineConsoleType( TypeF32Vector, Vector<F32> )
 72DefineUnmappedConsoleType( TypeString, const char * ) // plain UTF-8 strings are not supported in new interop
 73DefineConsoleType( TypeCaseString, const char * )
 74DefineConsoleType( TypeRealString, String )
 75DefineConsoleType( TypeCommand, String )
 76DefineConsoleType( TypeFilename, const char * )
 77DefineConsoleType( TypeStringFilename, String )
 78
 79DefineConsoleType(TypeRotationF, RotationF)
 80
 81/// A universally unique identifier.
 82DefineConsoleType( TypeUUID, Torque::UUID )
 83
 84/// A persistent ID that is associated with an object.  This type cannot
 85/// be used to reference PIDs of other objects.
 86DefineUnmappedConsoleType( TypePID, SimPersistID* );
 87
 88/// TypeImageFilename is equivalent to TypeStringFilename in its usage,
 89/// it exists for the benefit of GuiInspector, which will provide a custom
 90/// InspectorField for this type that can display a texture preview.
 91DefineConsoleType( TypeImageFilename, String )
 92
 93/// TypePrefabFilename is equivalent to TypeStringFilename in its usage,
 94/// it exists for the benefit of GuiInspector, which will provide a 
 95/// custom InspectorField for this type.
 96DefineConsoleType( TypePrefabFilename, String )
 97
 98/// TypeShapeFilename is equivalent to TypeStringFilename in its usage,
 99/// it exists for the benefit of GuiInspector, which will provide a 
100/// custom InspectorField for this type.
101DefineConsoleType( TypeShapeFilename, String )
102
103/// TypeMaterialName is equivalent to TypeRealString in its usage,
104/// it exists for the benefit of GuiInspector, which will provide a 
105/// custom InspectorField for this type.
106DefineConsoleType( TypeMaterialName, String )
107
108/// TypeTerrainMaterialIndex is equivalent to TypeS32 in its usage,
109/// it exists for the benefit of GuiInspector, which will provide a 
110/// custom InspectorField for this type.
111DefineConsoleType( TypeTerrainMaterialIndex, S32 )
112
113/// TypeTerrainMaterialName is equivalent to TypeString in its usage,
114/// it exists for the benefit of GuiInspector, which will provide a 
115/// custom InspectorField for this type.
116DefineConsoleType( TypeTerrainMaterialName, const char * )
117
118/// TypeCubemapName is equivalent to TypeRealString in its usage,
119/// but the Inspector will provide a drop-down list of CubemapData objects.
120DefineConsoleType( TypeCubemapName, String )
121
122DefineConsoleType( TypeParticleParameterString, const char * )
123
124DefineConsoleType( TypeFlag, S32 )
125DefineConsoleType( TypeColorI, ColorI )
126DefineConsoleType( TypeColorF, LinearColorF )
127DefineConsoleType( TypeSimObjectName, SimObject* )
128DefineConsoleType( TypeShader, GFXShader * )
129
130DefineConsoleType(TypeSimObjectPtr, SimObject*)
131
132/// A persistent reference to an object.  This reference indirectly goes
133/// through the referenced object's persistent ID.
134DefineConsoleType( TypeSimPersistId, SimPersistID* )
135
136/// Special field type for SimObject::objectName
137DefineConsoleType( TypeName, const char* )
138
139/// TypeRectUV is equivalent to TypeRectF in its usage,
140/// it exists for the benefit of GuiInspector, which will provide a 
141/// custom InspectorField for this type.
142DefineConsoleType( TypeRectUV, RectF )
143
144/// @}
145
146#endif
147