UNDOCUMENTED
Classes:
A type of marker that designates a location AI characters can take cover.
Volumetric Fog Object class. Main class defining the Volumetric Fog objects in the scene. Used in conjunction with the VolumetricFogRTManager class which is responsible for the required rendertargets.
Enumerations
_TamlFormatMode { xml binary }
CoverPointSize { Prone Crouch Stand }
The size of a cover point.
NavMeshWaterMethod { Ignore Solid Impassable }
The method used to include water surfaces in the NavMesh.
VActionToggle { ON OFF }
VDataTableDataType { EXPRESSION STATIC VARIABLE }
VPathEditorMode { GIZMO ADDNODE DELETENODE }
VPathNodeOrientationType { FREE TOPOINT }
VPathObjectOrientationType { FREE INTERPOLATE TOPATH TOOBJECT TOPOINT }
VPathType { BEZIER LINEAR }
VScriptEventCommandType { EXPRESSION METHOD }
Variables
void
[string1, string2, ...]Adds case sensitive strings to the StringTable.
bool
Indicates if local lights(point/spot) can cast shadows.
bool
int
string
string
bool
bool
float
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables rendering of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
bool
Disables selection of all instances of this type.
float
Scales how long PhysicsDebris will live before being removed.
float
Distance at which light fading should have fully faded if $pref::useLightFade is on.
float
Distance at which light fading begins if $pref::useLightFade is on.
int
The maximum number of local lights that can be rendered at a time. If set to -1, then no limit.
float
Max distance for reflection probes to render.
int
Max number of Environment Probes that can be rendered per-frame.
bool
Determines if the shape will recieve corrections from the server or will instead be allowed to diverge.
bool
Determines if client-side shapes will attempt to smoothly transition to their new position after reciving a correction.
string
float
int
schedule(time, refobject|0, command,
filename
float
Distance at which static object fading should have fully faded if $pref::useStaticObjectFade is on.
float
Distance at which static object fading begins if $pref::useStaticObjectFade is on.
float
Size of object where if the bounds is at or bigger than this, it will be ignored in the $pref::useStaticObjectFade logic. Useful for very large, distance-important objects.
float
float
Minimum distance moved per frame to determine that we are teleporting.
float
float
Minimum angle moved per frame to determine that we are turning quickly.
filename
bool
Indicates if local lights should utilize the distance-based object fadeout logic.
bool
Indicates if all statics should utilize the distance-based object fadeout logic.
Functions
int
aiAddPlayer(string name, string ns)
'playerName'[, 'AIClassType'] );
void
Assert(bool condition, string message)
Fatal Script Assertion.
void
cancel(int eventId)
cancel(eventId)
void
cancelAll(string objectId)
cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.
void
void
void
void
CompileLanguage(string inputFile, bool createMap)
Compiles a LSO language file. if createIndex is true, will also create languageMap.cs with the global variables for each string index. The input file must follow this example layout: TXT_HELLO_WORLD = Hello world in english!
bool
decalManagerEditDecal(int decalID, Point3F pos, Point3F normal, float rotAroundNormal, float decalScale)
Edit specified decal of the decal manager.
void
Delete all the datablocks we've downloaded.
void
void
Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console.
void
enableWinConsole(bool _enable)
string
eval(string consoleString)
eval(consoleString)
int
extractDatablockCacheCRC(string fileName)
bool
Generate a TAML schema file of all engine types.
int
int
getEventTimeLeft(int scheduleId)
getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.
String
getFirstNumber(string str)
Get the first occuring number from str.
string
Returns a list of supported shape format extensions separated by tabs.Example output: *.dsq TAB *.dae TAB.
string
Returns a list of supported shape formats in filter form.
int
Get max number of allowable dynamic vertices in a single vertex buffer.
int
String
int
Get the EventManager object for all NavMesh updates.
int
Get the root Scene object that is loaded.
int
Get the number of active Scene objects that are loaded.
int
getScheduleDuration(int scheduleId)
getScheduleDuration(scheduleId);
int
int
int
Gets a count of available stock colors.
LinearColorF
getStockColorF(string stockColorName)
Gets a floating-point-based stock color by name.
ColorI
getStockColorI(string stockColorName)
Gets a byte-based stock color by name.
string
getStockColorName(int stockColorIndex)
Gets the stock color name at the specified index.
int
getTimeSinceStart(int scheduleId)
getTimeSinceStart(scheduleId);
bool
bool
isEventPending(int scheduleId)
isEventPending(scheduleId);
bool
isObject(string objectName)
isObject(object)
bool
isStockColor(string stockColorName)
Gets whether the specified name is a stock color or not.
bool
isSupportedFormat(string extension)
int
mRound(float v)
Round v to the nth decimal place or the nearest whole number by default.
float
mRoundColour(float v, int n)
Round v to the nth decimal place or the nearest whole number by default.
int
mRoundDelta(float v, int d)
Round v to the nearest number based on the delta.
int
nameToID(string objectName)
nameToID(object)
void
NavMeshIgnore(int objid, bool _ignore)
Flag this object as not generating a navmesh result.
void
NavMeshUpdateAll(int objid, bool remove)
Update all NavMesh tiles that intersect the given object's world box.
void
NavMeshUpdateAroundObject(int objid, bool remove)
Update all NavMesh tiles that intersect the given object's world box.
void
NavMeshUpdateOne(int meshid, int objid, bool remove)
Update all tiles in a given NavMesh that intersect the given object's world box.
void
physicsDebugDraw(bool enable)
void
void
physicsDestroyWorld(string worldName)
physicsDestroyWorld( String worldName )
bool
physicsInit(string library)
physicsInit( [string library] )
bool
physicsInitWorld(string worldName)
physicsInitWorld( String worldName )
void
physicsSetTimeScale(float scale)
physicsSetTimeScale( F32 scale )
bool
physicsStopSimulation( String worldName )
void
physicsStartSimulation(string worldName)
physicsStartSimulation( String worldName )
void
physicsStopSimulation(string worldName)
physicsStopSimulation( String worldName )
void
Preload all datablocks in client mode.
void
queryAllServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags)
queryAllServers(...);
void
queryLanServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags)
queryLanServers(...);
void
queryMasterServer(uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags)
queryMasterServer(...);
void
querySingleServer(string addrText, U8 flags)
querySingleServer(address, flags);
void
realQuit()
void
void
ResetGFX()
forces the gbuffer to be reinitialized in cases of improper/lack of buffer clears.
void
saveCompositeTexture(string pathR, string pathG, string pathB, string pathA, string inputKeyString, string saveAs)
File1,file2,file3,file4,[chanels for r g b and a locations],saveAs.
void
void
void
setDatablockCacheCRC(uint crc)
int
SetFogVolumeQuality(uint new_quality)
Resizes the rendertargets of the Volumetric Fog object. @params new_quality new quality for the rendertargets 1 = full size, 2 = halfsize, 3 = 1/3, 4 = 1/4 ...
void
setMainDotCsDir(string path)
bool
setServerInfo(uint index)
setServerInfo(index);
bool
setShadowManager(string sShadowSystemName)
string sShadowSystemName
string
setShadowVizLight(string name)
void
ShakeCamera(float duration, float falloff, VectorF amplitude, VectorF frequency)
void
int
startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id.
void
int
stopPrecisionTimer(int id)
stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds.
void
string
strToPlayerName(string ptr)
bool
void
tsUpdateImposterImages(bool forceUpdate)
string
VectorRot(Point3F v, float angle)
rotate a vector in 2d
Detailed Description
Enumerations
_TamlFormatMode
Enumerator
- xml
- binary
CoverPointSize
Enumerator
- Prone
Only provides cover when prone.
Prone pose.
- Crouch
Only provides cover when crouching.
Crouch pose.
- Stand
Provides cover when standing.
Standard movement pose.
The size of a cover point.
NavMeshWaterMethod
Enumerator
- Ignore
Ignore all water surfaces.
Ignore the loaded state.
No changes to the spin sequence.
- Solid
Treat water surfaces as solid and walkable.
- Impassable
Treat water as an impassable obstacle.
The method used to include water surfaces in the NavMesh.
VActionToggle
Enumerator
- ON
- OFF
VDataTableDataType
Enumerator
- EXPRESSION
- STATIC
- VARIABLE
VPathEditorMode
Enumerator
- GIZMO
- ADDNODE
- DELETENODE
VPathNodeOrientationType
Enumerator
- FREE
- TOPOINT
VPathObjectOrientationType
Enumerator
- FREE
- INTERPOLATE
- TOPATH
- TOOBJECT
- TOPOINT
VPathType
Enumerator
- BEZIER
- LINEAR
VScriptEventCommandType
Enumerator
- EXPRESSION
- METHOD
Variables
void addCaseSensitiveStrings
[string1, string2, ...]Adds case sensitive strings to the StringTable.
bool allowLocalLightShadows
Indicates if local lights(point/spot) can cast shadows.
bool clickToTargetSelf
int collisionMask
bool corpsesHiddenFromRayCast
string DatablockCacheFilename
string DatablockCacheFilename
bool EnableDatablockCache
bool EnableDatablockCache
int freeTargetSelectionMask
float interiorZodiacZBias
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isRenderable
Disables rendering of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
bool isSelectable
Disables selection of all instances of this type.
float lifetimeScale
Scales how long PhysicsDebris will live before being removed.
note:A value of 0 will disable PhysicsDebris entirely.
float lightFadeEnd
Distance at which light fading should have fully faded if $pref::useLightFade is on.
float lightFadeStart
Distance at which light fading begins if $pref::useLightFade is on.
int maximumNumOfLights
The maximum number of local lights that can be rendered at a time. If set to -1, then no limit.
float maxProbeDrawDistance
Max distance for reflection probes to render.
int MaxProbesPerFrame
Max number of Environment Probes that can be rendered per-frame.
int missileCollisionMask
bool noCorrections
Determines if the shape will recieve corrections from the server or will instead be allowed to diverge.
In the event that the client and server object positions/orientations differ and if this variable is true, the server will attempt to 'correct' the client object to keep it in sync. Otherwise, client and server objects may fall out of sync.
bool noSmoothing
Determines if client-side shapes will attempt to smoothly transition to their new position after reciving a correction.
If true, shapes will immediately render at the position they are corrected to.
string parameterFieldPrefix
float polysoupZodiacZBias
bool preferDestinationGradients
void restartInstance
int schedule
schedule(time, refobject|0, command,
filename spellCooldownBitmaps
float staticObjectFadeEnd
Distance at which static object fading should have fully faded if $pref::useStaticObjectFade is on.
float staticObjectFadeStart
Distance at which static object fading begins if $pref::useStaticObjectFade is on.
float staticObjectUnfadeableSize
Size of object where if the bounds is at or bigger than this, it will be ignored in the $pref::useStaticObjectFade logic. Useful for very large, distance-important objects.
int targetSelectionMask
float targetSelectionRange
int targetSelectionTimeoutMS
float teleportDist
Minimum distance moved per frame to determine that we are teleporting.
float terrainZodiacZBias
float turnRate
Minimum angle moved per frame to determine that we are turning quickly.
filename unknownSpellBitmap
bool useLightFade
Indicates if local lights should utilize the distance-based object fadeout logic.
bool usePlayerCentricListener
bool useStaticObjectFade
Indicates if all statics should utilize the distance-based object fadeout logic.
Functions
aiAddPlayer(string name, string ns)
'playerName'[, 'AIClassType'] );
Assert(bool condition, string message)
Fatal Script Assertion.
cancel(int eventId)
cancel(eventId)
cancelAll(string objectId)
cancelAll(objectId): cancel pending events on the specified object. Events will be automatically cancelled if object is deleted.
cancelServerQuery()
clearClientPaths()
UNDOCUMENTED!
clearServerPaths()
UNDOCUMENTED!
CompileLanguage(string inputFile, bool createMap)
Compiles a LSO language file. if createIndex is true, will also create languageMap.cs with the global variables for each string index. The input file must follow this example layout: TXT_HELLO_WORLD = Hello world in english!
decalManagerEditDecal(int decalID, Point3F pos, Point3F normal, float rotAroundNormal, float decalScale)
Edit specified decal of the decal manager.
Parameters:
| decalID | ID of the decal to edit. |
| pos | World position for the decal. |
| normal | Decal normal vector (if the decal was a tire lying flat on a surface, this is the vector pointing in the direction of the axle). |
| rotAroundNormal | Angle (in radians) to rotate this decal around its normal vector. |
| decalScale | Scale factor applied to the decal. |
Returns true if successful, false if decalID not found.
deleteDataBlocks()
Delete all the datablocks we've downloaded.
This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup.
dumpActivePostFX()
UNDOCUMENTED!
dumpProcessList()
Dumps all ProcessObjects in ServerProcessList and ClientProcessList to the console.
enableWinConsole(bool _enable)
eval(string consoleString)
eval(consoleString)
extractDatablockCacheCRC(string fileName)
UNDOCUMENTED!
GenerateTamlSchema()
Generate a TAML schema file of all engine types.
The schema file is specified using the console variable '$pref::T2D::TAMLSchema'.
Whether the schema file was writtent or not.
getDatablockCacheCRC()
UNDOCUMENTED!
getEventTimeLeft(int scheduleId)
getEventTimeLeft(scheduleId) Get the time left in ms until this event will trigger.
getFirstNumber(string str)
Get the first occuring number from str.
Parameters:
| str | The string from which to read out the first number. |
String representation of the number or if no number.
getFormatExtensions()
Returns a list of supported shape format extensions separated by tabs.Example output: *.dsq TAB *.dae TAB.
getFormatFilters()
Returns a list of supported shape formats in filter form.
Example output: DSQ Files|*.dsq|COLLADA Files|*.dae|
getMaxDynamicVerts()
Get max number of allowable dynamic vertices in a single vertex buffer.
the max number of allowable dynamic vertices in a single vertex buffer
getMaxFrameAllocation()
UNDOCUMENTED!
getNamedTargetList()
UNDOCUMENTED!
getNavMeshEventManager()
Get the EventManager object for all NavMesh updates.
getRootScene()
Get the root Scene object that is loaded.
The id of the Root Scene. Will be 0 if no root scene is loaded
getScene(uint sceneId)
Get the root Scene object that is loaded.
The id of the Root Scene. Will be 0 if no root scene is loaded
getSceneCount()
Get the number of active Scene objects that are loaded.
The number of active scenes
getScheduleDuration(int scheduleId)
getScheduleDuration(scheduleId);
getServerCount()
getServerPathSet()
UNDOCUMENTED!
getStockColorCount()
Gets a count of available stock colors.
A count of available stock colors.
getStockColorF(string stockColorName)
Gets a floating-point-based stock color by name.
Parameters:
| stockColorName | - The stock color name to retrieve. |
The stock color that matches the specified color name. Returns nothing if the color name is not found.
getStockColorI(string stockColorName)
Gets a byte-based stock color by name.
Parameters:
| stockColorName | - The stock color name to retrieve. |
The stock color that matches the specified color name. Returns nothing if the color name is not found.
getStockColorName(int stockColorIndex)
Gets the stock color name at the specified index.
Parameters:
| stockColorIndex | The zero-based index of the stock color name to retrieve. |
The stock color name at the specified index or nothing if the string is invalid.
getTimeSinceStart(int scheduleId)
getTimeSinceStart(scheduleId);
getUserDataDirectory()
getUserHomeDirectory()
isDatablockCacheSaved()
UNDOCUMENTED!
isEventPending(int scheduleId)
isEventPending(scheduleId);
isObject(string objectName)
isObject(object)
isStockColor(string stockColorName)
Gets whether the specified name is a stock color or not.
Parameters:
| stockColorName | - The stock color name to test for. |
Whether the specified name is a stock color or not.
isSupportedFormat(string extension)
UNDOCUMENTED!
mRound(float v)
Round v to the nth decimal place or the nearest whole number by default.
Parameters:
| v | Value to roundn |
The rounded value as a S32.
mRoundColour(float v, int n)
Round v to the nth decimal place or the nearest whole number by default.
Parameters:
| v | Value to roundn |
| n | Number of decimal places to round to, 0 by defaultn |
The rounded value as a S32.
mRoundDelta(float v, int d)
Round v to the nearest number based on the delta.
Parameters:
| v | Value to round |
| d | Delta use when rounding |
The rounded value as a S32.
nameToID(string objectName)
nameToID(object)
NavMeshIgnore(int objid, bool _ignore)
Flag this object as not generating a navmesh result.
NavMeshUpdateAll(int objid, bool remove)
Update all NavMesh tiles that intersect the given object's world box.
NavMeshUpdateAroundObject(int objid, bool remove)
Update all NavMesh tiles that intersect the given object's world box.
NavMeshUpdateOne(int meshid, int objid, bool remove)
Update all tiles in a given NavMesh that intersect the given object's world box.
physicsDebugDraw(bool enable)
physicsDebugDraw( bool enable )
physicsDestroy()
physicsDestroyWorld(string worldName)
physicsDestroyWorld( String worldName )
physicsGetTimeScale()
physicsInit(string library)
physicsInit( [string library] )
physicsInitWorld(string worldName)
physicsInitWorld( String worldName )
physicsRestoreState()
physicsSetTimeScale(float scale)
physicsSetTimeScale( F32 scale )
physicsSimulationEnabled()
physicsStopSimulation( String worldName )
physicsStartSimulation(string worldName)
physicsStartSimulation( String worldName )
physicsStopSimulation(string worldName)
physicsStopSimulation( String worldName )
physicsStoreState()
preloadClientDataBlocks()
Preload all datablocks in client mode.
(Server parameter is set to false). This will take some time to complete.
queryAllServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags)
queryAllServers(...);
queryLanServers(uint lanPort, uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags)
queryLanServers(...);
queryMasterServer(uint flags, string gameType, string missionType, uint minPlayers, uint maxPlayers, uint maxBots, uint regionMask, uint maxPing, uint minCPU, uint filterFlags)
queryMasterServer(...);
querySingleServer(string addrText, U8 flags)
querySingleServer(address, flags);
realQuit()
UNDOCUMENTED!
resetDatablockCache()
UNDOCUMENTED!
ResetGFX()
forces the gbuffer to be reinitialized in cases of improper/lack of buffer clears.
saveCompositeTexture(string pathR, string pathG, string pathB, string pathA, string inputKeyString, string saveAs)
File1,file2,file3,file4,[chanels for r g b and a locations],saveAs.
sbmDumpStats()
UNDOCUMENTED!
sbmDumpStrings()
UNDOCUMENTED!
setDatablockCacheCRC(uint crc)
UNDOCUMENTED!
SetFogVolumeQuality(uint new_quality)
Resizes the rendertargets of the Volumetric Fog object. @params new_quality new quality for the rendertargets 1 = full size, 2 = halfsize, 3 = 1/3, 4 = 1/4 ...
setMainDotCsDir(string path)
setServerInfo(uint index)
setServerInfo(index);
setShadowManager(string sShadowSystemName)
string sShadowSystemName
setShadowVizLight(string name)
UNDOCUMENTED!
ShakeCamera(float duration, float falloff, VectorF amplitude, VectorF frequency)
UNDOCUMENTED!
startHeartbeat()
startPrecisionTimer()
startPrecisionTimer() - Create and start a high resolution platform timer. Returns the timer id.
stopHeartbeat()
stopPrecisionTimer(int id)
stopPrecisionTimer( S32 id ) - Stop and destroy timer with the passed id. Returns the elapsed milliseconds.
stopServerQuery()
strToPlayerName(string ptr)
TamlRead(string filename, string format)
Read an object from a file using Taml.
Parameters:
| filename | The filename to read from. |
| format | The file format to use. Optional: Defaults to 'xml'. Can be set to 'binary'. |
(Object) The object read from the file or an empty string if read failed.
TamlWrite(SimObject simObject, string filename, string format, bool compressed)
Writes an object to a file using Taml.
Parameters:
| object | The object to write. |
| filename | The filename to write to. |
| format | The file format to use. Optional: Defaults to 'xml'. Can be set to 'binary'. |
| compressed | Whether ZIP compression is used on binary formatting or not. Optional: Defaults to 'true'. |
Whether the write was successful or not.
tsUpdateImposterImages(bool forceUpdate)
tsUpdateImposterImages( bool forceupdate )
VectorRot(Point3F v, float angle)
rotate a vector in 2d