Difference between revisions of "TOBJ"

From GTAMods Wiki
Jump to navigation Jump to search
(Statistics)
m (corrected NightFlags to ActiveHours and added statistics for GTAIV.)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{IdeSection
 
{{IdeSection
| game        = [[GTA III]], [[GTA VC]], [[GTA SA]], [[GTA IV]]
+
|game        = {{Icon|t}} {{Icon|LCS}} {{Icon|4}}
| description = Used to define timed map objects
+
|description = Defines timed map objects
 
}}
 
}}
'''TOBJ''' is a section in the [[item definition]] file. It is used to define standart map objects with an additional ingame time range defining when the object gets rendered. It's format is similar to [[OBJS|standart map objects]]. [[GTA IV]] does also support time controlled objects linked to animations. For more information about this see [[TANM]].
+
'''<code>tobj</code>''' is a section in the [[item definition]] file in [[GTA III]], [[Vice City]], [[San Andreas]], [[Liberty City Stories]], and [[GTA IV]]. It is used to define standard map objects similar to the <code>[[OBJS|objs]]</code> section with an additional in-game time range defining when the object gets rendered. [[GTA IV]] also support time controlled objects linked to animations through the <code>[[TANM|tanm]]</code> section. Most, if not all, time objects use the [[Item Definition#IDE Flags|object flag]] 2 to prevent them from fading into and out of view at those times.
  
 +
== Format ==
 +
=== GTA III &ndash; Liberty City Stories ===
 +
{{Pre|
 +
tobj
 +
# [[#Type 1|type 1]] (III/VC/SA/LCS)
 +
Id, ModelName, TxdName, MeshCount, DrawDistance, Flags, TimeOn, TimeOff
 +
# [[#Type 2|type 2]] (III/VC/SA/LCS)
 +
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, Flags, TimeOn, TimeOff
 +
# [[#Type 3|type 3]] (III/VC/SA/LCS)
 +
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, DrawDistance3, Flags, TimeOn, TimeOff
 +
# [[#Type 4|type 4]] (SA)
 +
Id, ModelName, TxdName, DrawDistance, Flags, TimeOn, TimeOff
 +
end
 +
}}
  
== Format ==
+
====Type 1====
 +
This is used for non-breakable objects.
 +
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 +
!style="width: 3em;" |{{Icon|3}} {{Icon|VC}}<br>{{Icon|SA}} {{Icon|LCS}}
 +
!style="width: 12em;" |Identifier
 +
!style="width: 6em;" |Type
 +
!Description
 +
|-
 +
|A ||Id ||integer ||Unique object identifier.
 +
|-
 +
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 +
|-
 +
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 +
|-
 +
|D ||MeshCount ||integer ||Number of meshes. 1 for this type.
 +
|-
 +
|E ||DrawDistance ||float ||[[Draw distance]] in [[unit]]s.
 +
|-
 +
|F ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 +
|-
 +
|G ||TimeOn ||integer ||Hour to appear
 +
|-
 +
|H ||TimeOff ||integer ||Hour to disappear
 +
|}
  
=== GTA III, Vice City and San Andreas ===
+
====Type 2====
{{Incomplete}}
+
This is used for breakable objects.
 +
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 +
!style="width: 3em;" |{{Icon|3}} {{Icon|VC}}<br>{{Icon|SA}} {{Icon|LCS}}
 +
!style="width: 12em;" |Identifier
 +
!style="width: 6em;" |Type
 +
!Description
 +
|-
 +
|A ||Id ||integer ||Unique object identifier.
 +
|-
 +
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 +
|-
 +
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 +
|-
 +
|D ||MeshCount ||integer ||Number of meshes. 2 for this type.
 +
|-
 +
|E,F ||DrawDistance1, DrawDistance2 ||float[2] ||[[Draw distance]] in [[unit]]s (one for each mesh, only the first is actually used).
 +
|-
 +
|G ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 +
|-
 +
|H ||TimeOn ||integer ||Hour to appear
 +
|-
 +
|I ||TimeOff ||integer ||Hour to disappear
 +
|}
  
ID, ModelName, TextureName, ObjectCount, DrawDistance, [DrawDistance2, ...], Flags, TimeOn, TimeOff
+
====Type 3====
 +
This is used for complex breakable objects.
 +
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 +
!style="width: 3em;" |{{Icon|3}} {{Icon|VC}}<br>{{Icon|SA}} {{Icon|LCS}}
 +
!style="width: 12em;" |Identifier
 +
!style="width: 6em;" |Type
 +
!Description
 +
|-
 +
|A ||Id ||integer ||Unique object identifier.
 +
|-
 +
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 +
|-
 +
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 +
|-
 +
|D ||MeshCount ||integer ||Number of meshes. 3 for this type.
 +
|-
 +
|E,F,G ||DrawDistance1, DrawDistance2, DrawDistance3 ||float[3] ||[[Draw distance]] in [[unit]]s (one for each mesh, only the first is actually used).
 +
|-
 +
|H ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 +
|-
 +
|I ||TimeOn ||integer ||Hour to appear
 +
|-
 +
|J ||TimeOff ||integer ||Hour to disappear
 +
|}
  
{|{{Prettytable}} width="100%"
+
====Type 4====
!width="250px"|Identifier
+
This is used for non-breakable objects and behaves equivalently to [[#Type 1|Type 1]].
 +
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 +
!style="width: 3em;" |{{Icon|SA}}
 +
!style="width: 12em;" |Identifier
 +
!style="width: 6em;" |Type
 
!Description
 
!Description
 
|-
 
|-
|<center>ID</center>||Unique object ID.
+
|A ||Id ||integer ||Unique object identifier.
 
|-
 
|-
|<center>ModelName</center>||Name of the <code>.dff</code> [[model file]] without extension.
+
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 
|-
 
|-
|<center>TextureName</center>||Name of the <code>.txd</code> [[texture dictionary]] without extension.
+
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 
|-
 
|-
|<center>ObjectCount</center>||Number of [[RenderWare_binary_stream_file|clumps]]. 1 by default and optional for ''San Andreas''.
+
|D ||DrawDistance ||float ||[[Draw distance]] in [[unit]]s.
 
|-
 
|-
|<center>DrawDistance</center>||[[Draw distance]] in [[unit]]s (one for each clump).
+
|E ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 
|-
 
|-
|<center>Flags</center>||Object flags (see [[TOBJ#Object_Flags|below]]).
+
|F ||TimeOn ||integer ||Hour to appear
 
|-
 
|-
|<center>TimeOn, TimeOff</center>||Activation and deactivation time in hours.
+
|G ||TimeOff ||integer ||Hour to disappear
 
|}
 
|}
  
 
=== GTA IV ===
 
=== GTA IV ===
 +
{{Pre|
 +
tobj
 +
ModelName, TxdName, DrawDistance, Flags, Unknown, MinX, MinY, MinZ, MaxX, MaxY, MaxZ, SphereX, SphereY, SphereZ, Radius, LODModel, NightFlag
 +
end
 +
}}
  
ModelName, TextureName, DrawDistance, Flags, Unknown, MinX, MinY, MinZ, MaxX, MaxY, MaxZ, SphereX, SphereY, SphereZ, Radius, LOD Model, NightFlag
+
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
+
!style="width: 3em;" |{{Icon|4}}
{|{{Prettytable}} width="100%"
+
!style="width: 12em;" |Identifier
!width="250px"|Identifier
+
!style="width: 6em;" |Type
 
!Description
 
!Description
 
|-
 
|-
|<center>ModelName</center>||Name of the <code>.wdr</code> ''model file'' without extension.
+
|A ||ModelName ||string ||Name of the <code>.wdr</code> ''model file'' without extension.
 
|-
 
|-
|<center>TextureName</center>||name of the <code>.wtd</code> ''texture dictionary'' without extension.
+
|B ||TxdName ||string ||name of the <code>.wtd</code> ''texture dictionary'' without extension.
 
|-
 
|-
|<center>DrawDistance</center>||''Draw distance'' in ''units''.
+
|C ||DrawDistance ||float ||Draw distance in units.
 
|-
 
|-
|<center>Flag1</center>||Object flag (see [[OBJS#Object Flags|below]]).
+
|D ||Flags ||integer ||[[Item Definition#IDE Flags|Object flag]]
 
|-
 
|-
|<center>Unknown</center>||Unknown integer (0 by default).
+
|E ||''unknown'' ||float ||Unknown integer (0 by default).
 
|-
 
|-
|<center>MinX, MinY, MinZ</center>||Lower left corner of the bounding box for the object.
+
|F,G,H ||MinX, MinY, MinZ ||float[3] ||Lower left corner of the bounding box for the object.
 
|-
 
|-
|<center>MaxX, MaxY, MaxZ</center>||Upper right corner of the bounding box for the object.
+
|I,J,K ||MaxX, MaxY, MaxZ ||float[3] ||Upper right corner of the bounding box for the object.
 
|-
 
|-
|<center>SphereX, SphereY, SphereZ</center>||Center of the bounding sphere for the object.
+
|L,M,N ||SphereX, SphereY, SphereZ ||float[3] ||Center of the bounding sphere for the object.
 
|-
 
|-
|<center>Radius</center>||Radius of the bounding sphere into all dimensions.
+
|O ||Radius ||float ||Radius of the bounding sphere into all dimensions.
 
|-
 
|-
|<center>LOD Model</center>||Name of the <code>.[[wdd]]</code> file that contains the ''lod model'' for the defined modelname.
+
|P ||LODModel||string ||Name of the <code>[[WDD|.wdd]]</code> file that contains the ''lod model'' for the defined modelname.
 
|-
 
|-
|<center>NightFlag</center>||If enabled (1) the object only shows at nighttime, otherwise the object gets only rendered at daytime. Day- and nighttimes are [[hardcoded]].
+
|Q ||ActiveHours||integer ||Hours of the day where the model is active as a bit field. with the first bit being midnight and the 24th 11PM.
 
|}
 
|}
 
For more information read the definition of [[OBJS#GTA_IV|Standart map files]].
 
 
== Object Flags ==
 
 
Flags are used to specify the behaviour of objects. They are signed 32-bit integer values where each bit descripes a [[wikipedia:Boolean_algebra_(logic)|boolean]] value of an special aspect.
 
{{Object-Flags}}
 
  
 
== Statistics ==
 
== Statistics ==
== Statistics ==
+
Total number of <code>tobj</code> entries in:
Total number of TOBJ entries in:
+
:GTA III: 24 (max 30)
:GTA III: 24
+
:Vice City: 342 (max 385)
:Vice City: 342
+
:San Andreas: 160
 
+
:GTA IV: 1558
== See also ==
 
* [[Item definition]]
 
* [[OBJS]]
 
* [[TANM]]
 
  
[[Category:GTA 3]][[Category:GTA VC]]
+
{{N|4|LCS|SA|VC|3}}
{{N|4|SA}}
+
[[Category:GTA LCS]]

Latest revision as of 19:35, 29 September 2024

TOBJ (IDE section)
Supported games:GTA III Vice City San Andreas Liberty City Stories GTA IV
Brief description:Defines timed map objects
IDE Sections:
2DFX AMAT ANIM CARS HIER HAND MLO OBJS
PATH PEDS TANM TOBJ TREE TXDP WEAP

tobj is a section in the item definition file in GTA III, Vice City, San Andreas, Liberty City Stories, and GTA IV. It is used to define standard map objects similar to the objs section with an additional in-game time range defining when the object gets rendered. GTA IV also support time controlled objects linked to animations through the tanm section. Most, if not all, time objects use the object flag 2 to prevent them from fading into and out of view at those times.

Format

GTA III – Liberty City Stories

tobj
# type 1 (III/VC/SA/LCS)
Id, ModelName, TxdName, MeshCount, DrawDistance, Flags, TimeOn, TimeOff
# type 2 (III/VC/SA/LCS)
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, Flags, TimeOn, TimeOff
# type 3 (III/VC/SA/LCS)
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, DrawDistance3, Flags, TimeOn, TimeOff
# type 4 (SA)
Id, ModelName, TxdName, DrawDistance, Flags, TimeOn, TimeOff
end

Type 1

This is used for non-breakable objects.

GTA III Vice City
San Andreas Liberty City Stories
Identifier Type Description
A Id integer Unique object identifier.
B ModelName string Name of the model file without extension.
C TxdName string Name of the texture dictionary without extension.
D MeshCount integer Number of meshes. 1 for this type.
E DrawDistance float Draw distance in units.
F Flags integer Object flags
G TimeOn integer Hour to appear
H TimeOff integer Hour to disappear

Type 2

This is used for breakable objects.

GTA III Vice City
San Andreas Liberty City Stories
Identifier Type Description
A Id integer Unique object identifier.
B ModelName string Name of the model file without extension.
C TxdName string Name of the texture dictionary without extension.
D MeshCount integer Number of meshes. 2 for this type.
E,F DrawDistance1, DrawDistance2 float[2] Draw distance in units (one for each mesh, only the first is actually used).
G Flags integer Object flags
H TimeOn integer Hour to appear
I TimeOff integer Hour to disappear

Type 3

This is used for complex breakable objects.

GTA III Vice City
San Andreas Liberty City Stories
Identifier Type Description
A Id integer Unique object identifier.
B ModelName string Name of the model file without extension.
C TxdName string Name of the texture dictionary without extension.
D MeshCount integer Number of meshes. 3 for this type.
E,F,G DrawDistance1, DrawDistance2, DrawDistance3 float[3] Draw distance in units (one for each mesh, only the first is actually used).
H Flags integer Object flags
I TimeOn integer Hour to appear
J TimeOff integer Hour to disappear

Type 4

This is used for non-breakable objects and behaves equivalently to Type 1.

San Andreas Identifier Type Description
A Id integer Unique object identifier.
B ModelName string Name of the model file without extension.
C TxdName string Name of the texture dictionary without extension.
D DrawDistance float Draw distance in units.
E Flags integer Object flags
F TimeOn integer Hour to appear
G TimeOff integer Hour to disappear

GTA IV

tobj
ModelName, TxdName, DrawDistance, Flags, Unknown, MinX, MinY, MinZ, MaxX, MaxY, MaxZ, SphereX, SphereY, SphereZ, Radius, LODModel, NightFlag
end
GTA IV Identifier Type Description
A ModelName string Name of the .wdr model file without extension.
B TxdName string name of the .wtd texture dictionary without extension.
C DrawDistance float Draw distance in units.
D Flags integer Object flag
E unknown float Unknown integer (0 by default).
F,G,H MinX, MinY, MinZ float[3] Lower left corner of the bounding box for the object.
I,J,K MaxX, MaxY, MaxZ float[3] Upper right corner of the bounding box for the object.
L,M,N SphereX, SphereY, SphereZ float[3] Center of the bounding sphere for the object.
O Radius float Radius of the bounding sphere into all dimensions.
P LODModel string Name of the .wdd file that contains the lod model for the defined modelname.
Q ActiveHours integer Hours of the day where the model is active as a bit field. with the first bit being midnight and the 24th 11PM.

Statistics

Total number of tobj entries in:

GTA III: 24 (max 30)
Vice City: 342 (max 385)
San Andreas: 160
GTA IV: 1558