Difference between revisions of "TOBJ"

From GTAMods Wiki
Jump to navigation Jump to search
m
m (corrected NightFlags to ActiveHours and added statistics for GTAIV.)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{IdeSection
 
{{IdeSection
| game        = {{Icon|t}} {{Icon|4}}
+
|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 in [[GTA III]], [[Vice City]], [[San Andreas]], 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 flags|object flag]] 2 to prevent them from fading into and out of view at those times.
+
'''<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 ==
 
== Format ==
=== GTA III, Vice City, and San Andreas ===
+
=== GTA III &ndash; Liberty City Stories ===
 
{{Pre|
 
{{Pre|
 
tobj
 
tobj
# [[#Type 1|type 1]] (III/VC/SA)
+
# [[#Type 1|type 1]] (III/VC/SA/LCS)
 
Id, ModelName, TxdName, MeshCount, DrawDistance, Flags, TimeOn, TimeOff
 
Id, ModelName, TxdName, MeshCount, DrawDistance, Flags, TimeOn, TimeOff
# [[#Type 2|type 2]] (III/VC/SA)
+
# [[#Type 2|type 2]] (III/VC/SA/LCS)
 
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, Flags, TimeOn, TimeOff
 
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, Flags, TimeOn, TimeOff
# [[#Type 3|type 3]] (III/VC/SA)
+
# [[#Type 3|type 3]] (III/VC/SA/LCS)
 
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, DrawDistance3, Flags, TimeOn, TimeOff
 
Id, ModelName, TxdName, MeshCount, DrawDistance1, DrawDistance2, DrawDistance3, Flags, TimeOn, TimeOff
 
# [[#Type 4|type 4]] (SA)
 
# [[#Type 4|type 4]] (SA)
Line 19: Line 19:
 
end
 
end
 
}}
 
}}
 
====Type 0====
 
This type should never be used but it is still considered valid. It is documented here for sake of completion.
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
! style="width: 4em;"| {{Icon|t}}
 
! style="width: 12em;"| Identifier
 
! style="width: 6em;" | Type
 
! Description
 
|-
 
| A || Id || integer || Unique object ID.
 
|-
 
| B || ModelName || string || Name of the <code>.dff</code> [[model file]] without extension.
 
|-
 
| C || TxdName || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
 
|-
 
| D || ''unknown'' || integer || ''unknown''
 
|}
 
  
 
====Type 1====
 
====Type 1====
 
This is used for non-breakable objects.
 
This is used for non-breakable objects.
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
! style="width: 4em;"| {{Icon|t}}
+
!style="width: 3em;" |{{Icon|3}} {{Icon|VC}}<br>{{Icon|SA}} {{Icon|LCS}}
! style="width: 12em;"| Identifier
+
!style="width: 12em;" |Identifier
! style="width: 6em;" | Type
+
!style="width: 6em;" |Type
! Description
+
!Description
 
|-
 
|-
| A || Id || integer || Unique object ID.
+
|A ||Id ||integer ||Unique object identifier.
 
|-
 
|-
| B || ModelName || string || Name of the <code>.dff</code> [[model file]] without extension.
+
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 
|-
 
|-
| C || TxdName || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
+
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 
|-
 
|-
| D || MeshCount || integer || Number of meshes. 1 for this type.
+
|D ||MeshCount ||integer ||Number of meshes. 1 for this type.
 
|-
 
|-
| E || DrawDistance || float || [[Draw distance]] in [[unit]]s.
+
|E ||DrawDistance ||float ||[[Draw distance]] in [[unit]]s.
 
|-
 
|-
| F || Flags || integer || Object flags (see [[#Object flags|below]]).
+
|F ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 
|-
 
|-
| G || TimeOn || integer || Hour to appear
+
|G ||TimeOn ||integer ||Hour to appear
 
|-
 
|-
| H || TimeOff || integer || Hour to disappear
+
|H ||TimeOff ||integer ||Hour to disappear
 
|}
 
|}
  
Line 65: Line 48:
 
This is used for breakable objects.
 
This is used for breakable objects.
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
! style="width: 4em;"| {{Icon|t}}
+
!style="width: 3em;" |{{Icon|3}} {{Icon|VC}}<br>{{Icon|SA}} {{Icon|LCS}}
! style="width: 12em;"| Identifier
+
!style="width: 12em;" |Identifier
! style="width: 6em;" | Type
+
!style="width: 6em;" |Type
! Description
+
!Description
 
|-
 
|-
| A || Id || integer || Unique object ID.
+
|A ||Id ||integer ||Unique object identifier.
 
|-
 
|-
| B || ModelName || string || Name of the <code>.dff</code> [[model file]] without extension.
+
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 
|-
 
|-
| C || TxdName || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
+
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 
|-
 
|-
| D || MeshCount || integer || Number of meshes. 2 for this type.
+
|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).
+
|E,F ||DrawDistance1, DrawDistance2 ||float[2] ||[[Draw distance]] in [[unit]]s (one for each mesh, only the first is actually used).
 
|-
 
|-
| G || Flags || integer || Object flags (see [[#Object flags|below]]).
+
|G ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 
|-
 
|-
| H || TimeOn || integer || Hour to appear
+
|H ||TimeOn ||integer ||Hour to appear
 
|-
 
|-
| I || TimeOff || integer || Hour to disappear
+
|I ||TimeOff ||integer ||Hour to disappear
 
|}
 
|}
  
Line 90: Line 73:
 
This is used for complex breakable objects.
 
This is used for complex breakable objects.
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
! style="width: 4em;"| {{Icon|t}}
+
!style="width: 3em;" |{{Icon|3}} {{Icon|VC}}<br>{{Icon|SA}} {{Icon|LCS}}
! style="width: 12em;"| Identifier
+
!style="width: 12em;" |Identifier
! style="width: 6em;" | Type
+
!style="width: 6em;" |Type
! Description
+
!Description
 
|-
 
|-
| A || Id || integer || Unique object ID.
+
|A ||Id ||integer ||Unique object identifier.
 
|-
 
|-
| B || ModelName || string || Name of the <code>.dff</code> [[model file]] without extension.
+
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 
|-
 
|-
| C || TxdName || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
+
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 
|-
 
|-
| D || MeshCount || integer || Number of meshes. 3 for this type.
+
|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).
+
|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 || Object flags (see [[#Object flags|below]]).
+
|H ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 
|-
 
|-
| I || TimeOn || integer || Hour to appear
+
|I ||TimeOn ||integer ||Hour to appear
 
|-
 
|-
| J || TimeOff || integer || Hour to disappear
+
|J ||TimeOff ||integer ||Hour to disappear
 
|}
 
|}
  
Line 115: Line 98:
 
This is used for non-breakable objects and behaves equivalently to [[#Type 1|Type 1]].
 
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%;"
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
! style="width: 3em;"| {{Icon|SA}}
+
!style="width: 3em;" |{{Icon|SA}}
! style="width: 12em;"| Identifier
+
!style="width: 12em;" |Identifier
! style="width: 6em;" | Type
+
!style="width: 6em;" |Type
! Description
+
!Description
 
|-
 
|-
| A || Id || integer || Unique object ID.
+
|A ||Id ||integer ||Unique object identifier.
 
|-
 
|-
| B || ModelName || string || Name of the <code>.dff</code> [[model file]] without extension.
+
|B ||ModelName ||string ||Name of the [[model file]] without extension.
 
|-
 
|-
| C || TxdName || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
+
|C ||TxdName ||string ||Name of the [[texture dictionary]] without extension.
 
|-
 
|-
| D || DrawDistance || float || [[Draw distance]] in [[unit]]s.
+
|D ||DrawDistance ||float ||[[Draw distance]] in [[unit]]s.
 
|-
 
|-
| E || Flags || integer || Object flags (see [[#Object flags|below]]).
+
|E ||Flags ||integer ||[[Item Definition#IDE Flags|Object flags]]
 
|-
 
|-
| F || TimeOn || integer || Hour to appear
+
|F ||TimeOn ||integer ||Hour to appear
 
|-
 
|-
| G || TimeOff || integer || Hour to disappear
+
|G ||TimeOff ||integer ||Hour to disappear
 
|}
 
|}
  
Line 143: Line 126:
  
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
! style="width: 3em;"| {{Icon|4}}
+
!style="width: 3em;" |{{Icon|4}}
! style="width: 12em;"| Identifier
+
!style="width: 12em;" |Identifier
! style="width: 6em;" | Type
+
!style="width: 6em;" |Type
! Description
+
!Description
 
|-
 
|-
 
|A ||ModelName ||string ||Name of the <code>.wdr</code> ''model file'' without extension.
 
|A ||ModelName ||string ||Name of the <code>.wdr</code> ''model file'' without extension.
Line 154: Line 137:
 
|C ||DrawDistance ||float ||Draw distance in units.
 
|C ||DrawDistance ||float ||Draw distance in units.
 
|-
 
|-
|D ||Flags ||integer ||Object flag (see [[OBJS#Object Flags|below]]).
+
|D ||Flags ||integer ||[[Item Definition#IDE Flags|Object flag]]
 
|-
 
|-
 
|E ||''unknown'' ||float ||Unknown integer (0 by default).
 
|E ||''unknown'' ||float ||Unknown integer (0 by default).
Line 166: Line 149:
 
|O ||Radius ||float ||Radius of the bounding sphere into all dimensions.
 
|O ||Radius ||float ||Radius of the bounding sphere into all dimensions.
 
|-
 
|-
|P ||LODModel||string ||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.
 
|-
 
|-
|Q ||NightFlag||integer ||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.
 
|}
 
|}
 
== Object flags ==
 
{{Object-Flags}}
 
  
 
== Statistics ==
 
== Statistics ==
Total number of TOBJ entries in:
+
Total number of <code>tobj</code> entries in:
 
:GTA III: 24 (max 30)
 
:GTA III: 24 (max 30)
 
:Vice City: 342 (max 385)
 
:Vice City: 342 (max 385)
 
:San Andreas: 160
 
:San Andreas: 160
 +
:GTA IV: 1558
  
== See also ==
+
{{N|4|LCS|SA|VC|3}}
* [[OBJS]], a similar section in the item definition file independent of time
+
[[Category:GTA LCS]]
* [[TANM]]
 
 
 
{{N|4|SA|VC|3}}
 

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