supportInfo – Talk

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 2: Line 2:
Here are some interesting new commands (in 1.08 hotfix) found using the supportInfo command. Locations are the markings on the game map for things like town names, peak heights of hills, forest type icons, rocky areas etc. This info is just my findings, nothing official or thoroughly tested:
Here are some interesting new commands (in 1.08 hotfix) found using the supportInfo command. Locations are the markings on the game map for things like town names, peak heights of hills, forest type icons, rocky areas etc. This info is just my findings, nothing official or thoroughly tested:


*b:LOCATION setType STRING
*b:LOCATION [[setType]] STRING
: Can be used to change the type of location. Types are defined in CfgLocationTypes. Eg: "RockArea","VegetationVineyard".
: Can be used to change the type of location. Types are defined in CfgLocationTypes. Eg: "RockArea","VegetationVineyard".
*b:LOCATION setVariable ARRAY
*b:LOCATION [[setVariable]] ARRAY
: Same as [[setVariable]].
: Same as object [[setVariable]].
*b:LOCATION attachObject OBJECT
*b:LOCATION [[attachObject]] OBJECT
: Attach location to an object, it's location will automatically update on the map. The objects orientation doesn't affect the location's orientation. Attach to [[objNull]] to detach from an object.
: Attach location to an object, it's location will automatically update on the map. The objects orientation doesn't affect the location's orientation. Attach to [[objNull]] to detach from an object.
*b:LOCATION setImportance SCALAR
*b:LOCATION [[setImportance]] SCALAR
: Importance probably controls which location shall be drawn on the map in case of overlap. Values defined in CfgLocationTypes in the config range from 1 (not-important) to 7 (important).
: Importance probably controls which location shall be drawn on the map in case of overlap. Values defined in CfgLocationTypes in the config range from 1 (not-important) to 7 (important).
*b:CONTROL drawLocation LOCATION
*b:CONTROL [[drawLocation]] LOCATION
: not tested
: not tested
*b:LOCATION setName STRING
*b:LOCATION [[setName]] STRING
: similar to [[setVehicleVarName]]. The use of these commands is beyond me.
: similar to [[setVehicleVarName]]. The use of these commands is beyond me.
*b:LOCATION getVariable STRING
*b:LOCATION [[getVariable]] STRING
: same as [[getVariable]]
: same as [[getVariable]]
*b:ARRAY in LOCATION
*b:ARRAY [[in]] LOCATION
: check if position is within location's area. Area is based on it's attached position. A non-trigger spatial test!
: check if position is within location's area. Area is based on it's attached position. A non-trigger spatial test!
*b:LOCATION setSize ARRAY
*b:LOCATION [[setSize]] ARRAY
: set the location's area size, [x,y]. Map visual representation of location does not change.
: set the location's area size, [x,y]. Map visual representation of location does not change.
*b:LOCATION setText STRING
*b:LOCATION [[setText]] STRING
: set's the triggers text. Used for text based location types.
: set's the triggers text. Used for text based location types.
*b:LOCATION setDirection SCALAR
*b:LOCATION [[setDirection]] SCALAR
: equivalent to [[setMarkerDir]]. Rotates the location area. Map visual representation of location does not rotate.
: equivalent to [[setMarkerDir]]. Rotates the location area. Map visual representation of location does not rotate.
*b:LOCATION setPosition ARRAY
*b:LOCATION [[setPosition]] ARRAY
: similar to [[setPos]]. Locations seem to have a 3D position.
: similar to [[setPos]]. Locations seem to have a 3D position.
*b:LOCATION setRectangular BOOL
*b:LOCATION [[setRectangular]] BOOL
: presumably locations are ellipses if they are not rectangular. No effect on map visuals.
: presumably locations are ellipses if they are not rectangular. No effect on map visuals.
*b:LOCATION setSide SIDE
*b:LOCATION [[setSide]] SIDE
: No idea what impact this has. MP testing required?
: No idea what impact this has. MP testing required?
*u:nearestLocations ARRAY
*u:[[nearestLocations]] ARRAY
: return nearest locations to a position array. Syntax is ''nearestLocations [positionArray,[locationType,locationType2,...],searchRadius]''
: return nearest locations to a position array. Syntax is ''nearestLocations [positionArray,[locationType,locationType2,...],searchRadius]''
*u:rectangular LOCATION
*u:[[rectangular]] LOCATION
: return location's shape
: return location's shape
*u:type LOCATION
*u:[[type]] LOCATION
: returns location's type.
: returns location's type.
*u:locationPosition LOCATION
*u:[[locationPosition]] LOCATION
: return location's actual location, works with attached object.
: return location's actual location, works with attached object.
*u:name LOCATION
*u:[[name]] LOCATION
: return location's name.
: return location's name.
*u:attachedObject LOCATION
*u:[[attachedObject]] LOCATION
: return the object a location is attached to.
: return the object a location is attached to.
*u:size LOCATION
*u:[[size]] LOCATION
: return location's size array [x,y]
: return location's size array [x,y]
*u:text LOCATION
*u:[[text]] LOCATION
: return location's text.
: return location's text.
*u:direction LOCATION
*u:[[direction]] LOCATION
: return location's direction. This does not change with the direction of an attached object.
: return location's direction. This does not change with the direction of an attached object.
*u:createLocation ARRAY
*u:[[createLocation]] ARRAY
: create a new location. returns the location. syntax is ''_myLocation = createLocation [locationType,positionArray,sizeX,sizeY]''
: create a new location. returns the location. syntax is ''_myLocation = createLocation [locationType,positionArray,sizeX,sizeY]''
*u:deleteLocation LOCATION
*u:[[deleteLocation]] LOCATION
: delete a location.
: delete a location.
*u:side LOCATION
*u:[[side]] LOCATION
: return location's side
: return location's side
*u:nearestLocation ARRAY
*u:[[nearestLocation]] ARRAY
: return the nearest location to a given position array of a given type. syntax = nearestLocation [positionArray,locationType]
: return the nearest location to a given position array of a given type. syntax = nearestLocation [positionArray,locationType]
*u:importance LOCATION
*u:[[importance]] LOCATION
: return location's importance value.
: return location's importance value.
*u:position LOCATION
*u:[[position]] LOCATION
: return location's position. If location is attached to an object, the returned value is the location's position if it were not attached to an object.
: return location's position. If location is attached to an object, the returned value is the location's position if it were not attached to an object.


This info needs a proper home. --[[User:Ceeeb|Ceeeb]] 11:07, 23 November 2007 (CET)
I've created new pages for these commands, please add to and correct them if you can--[[User:Ceeeb|Ceeeb]] 11:07, 23 November 2007 (CET)

Revision as of 11:42, 26 November 2007

Locations

Here are some interesting new commands (in 1.08 hotfix) found using the supportInfo command. Locations are the markings on the game map for things like town names, peak heights of hills, forest type icons, rocky areas etc. This info is just my findings, nothing official or thoroughly tested:

Can be used to change the type of location. Types are defined in CfgLocationTypes. Eg: "RockArea","VegetationVineyard".
Same as object setVariable.
Attach location to an object, it's location will automatically update on the map. The objects orientation doesn't affect the location's orientation. Attach to objNull to detach from an object.
Importance probably controls which location shall be drawn on the map in case of overlap. Values defined in CfgLocationTypes in the config range from 1 (not-important) to 7 (important).
not tested
similar to setVehicleVarName. The use of these commands is beyond me.
same as getVariable
  • b:ARRAY in LOCATION
check if position is within location's area. Area is based on it's attached position. A non-trigger spatial test!
set the location's area size, [x,y]. Map visual representation of location does not change.
set's the triggers text. Used for text based location types.
equivalent to setMarkerDir. Rotates the location area. Map visual representation of location does not rotate.
similar to setPos. Locations seem to have a 3D position.
presumably locations are ellipses if they are not rectangular. No effect on map visuals.
No idea what impact this has. MP testing required?
return nearest locations to a position array. Syntax is nearestLocations [positionArray,[locationType,locationType2,...],searchRadius]
return location's shape
returns location's type.
return location's actual location, works with attached object.
return location's name.
return the object a location is attached to.
return location's size array [x,y]
return location's text.
return location's direction. This does not change with the direction of an attached object.
create a new location. returns the location. syntax is _myLocation = createLocation [locationType,positionArray,sizeX,sizeY]
delete a location.
return location's side
return the nearest location to a given position array of a given type. syntax = nearestLocation [positionArray,locationType]
return location's importance value.
return location's position. If location is attached to an object, the returned value is the location's position if it were not attached to an object.

I've created new pages for these commands, please add to and correct them if you can--Ceeeb 11:07, 23 November 2007 (CET)