Difference between revisions of "ANIM"

From GTAMods Wiki
Jump to navigation Jump to search
(SA's section was wrong)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Stub}}
 
 
{{IdeSection
 
{{IdeSection
| game        = [[GTA SA]], [[GTA IV]]
+
| game        = {{Icon|SA}} {{Icon|4}}
| description = Used to define timed map objects
+
| description = Used to define animated map objects
 
}}
 
}}
'''ANIM''' is a section in the [[item definition]] file. It is used to define standard map objects linked to an animation. Its format is somewhat similar to [[OBJS|standard map objects]]. [[GTA IV]] added a section ([[TANM]]) that supports time controlled objects linked to animations.
+
'''ANIM''' is a section in the [[item definition]] file in [[San Andreas]] and [[GTA IV]]. It is used to define standard map objects linked to an animation. Its format is almost exactly like [[OBJS|standard map objects]] but with one additional parameter for the animation file. [[GTA IV]] added a section ([[TANM]]) that supports time controlled objects linked to animations.
  
 
== Format ==
 
== Format ==
  
 
=== San Andreas ===
 
=== San Andreas ===
 +
{{Pre|
 +
anim
 +
Id, ModelName, TxdName, AnimationName, DrawDistance, Flags
 +
end
 +
}}
  
{|{{Prettytable}} width="100%"
+
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
! width="10px"| {{Icon|SA}}
+
! style="width: 3em;"| {{Icon|SA}}
! width="150px"| Identifier
+
! style="width: 12em;"| Identifier
! width="100px"| Type
+
! style="width: 6em;" | Type
 
! Description
 
! Description
 
|-
 
|-
| <center>A</center> || <center>ID</center> || integer || Unique object ID.
+
| A || Id || integer || Unique object ID.
 
|-
 
|-
| <center>B</center> || <center>ModelName</center> || string || Name of the <code>.dff</code> [[model file]] without extension.
+
| B || ModelName || string || Name of the <code>.dff</code> [[model file]] without extension.
 
|-
 
|-
| <center>C</center> || <center>TextureName</center> || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
+
| C || TxdName || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
 
|-
 
|-
| <center>D</center> || <center>AnimationName</center> || string || Name of the <code>.ifp</code> [[animation file]] without extension.
+
| D || AnimationName || string || Name of the <code>.ifp</code> [[animation file]] without extension.
 
|-
 
|-
| <center>E</center> || <center>DrawDistance</center> || float || [[Draw distance]] in [[unit]]s.
+
| E || DrawDistance || float || [[Draw distance]] in [[unit]]s.
 
|-
 
|-
| <center>F</center> || <center>Flags</center> || integer || Object flags (see [[ANIM#Object_Flags|below]]).
+
| F || Flags || integer || [[Item Definition#IDE Flags|Object flags]]
 
|}
 
|}
  
Note that animated files are still having an static [[COL|collision]]. This means that the collision get's not animated since it does not contain bone information for the animation. If you want to move objects you can do this using [[SCM|mission script]]. {{ref|1}}
+
Note that animated models still have static [[COL|collisions]]. This means that the collision do not animate with the model since it does not contain bone information for the animation. If you want to move objects, you can do this using the [[SCM|script]]. {{ref|1}}
  
 
=== GTA IV ===
 
=== GTA IV ===
 +
{{Pre|
 +
anim
 +
ModelName, TxdName, AnimationName, DrawDistance, Flag, unknown, MinX, MinY, MinZ, MaxX, MaxY, MaxZ, SphereX, SphereY, SphereZ, Radius, LODModel
 +
end
 +
}}
  
{{Incomplete}}
+
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
 
+
! style="width: 3em;"| {{Icon|4}}
== Object Flags ==
+
! style="width: 12em;"| Identifier
 +
! style="width: 6em;" | Type
 +
! Description
 +
|-
 +
| A || ModelName || string || Name of the <code>[[WDR|.wdr]]</code> model file without extension.
 +
|-
 +
| B || TxdName || string || Name of the <code>[[WTD|.wtd]]</code> texture dictionary without extension.
 +
|-
 +
| C || AnimationName || string || Name of the <code>[[WAD|.wad]]</code> animation file without extension.
 +
|-
 +
| D || DrawDistance || float || Draw distance in units.
 +
|-
 +
| E || Flag || integer || [[Item Definition#IDE Flags|Object flag]]
 +
|-
 +
| F || ''unknown'' || float || Unknown integer (0 by default).
 +
|-
 +
| G,H,I || MinX, MinY, MinZ || float[3] || Lower left corner of the bounding box for the object.
 +
|-
 +
| J,K,L || MaxX, MaxY, MaxZ || float[3] || Upper right corner of the bounding box for the object.
 +
|-
 +
| M,N,O || SphereX, SphereY, SphereZ || float[3] || Center of the bounding sphere for the object.
 +
|-
 +
| P || Radius || float || Radius of the bounding sphere into all dimensions.
 +
|-
 +
| Q || LODModel || string || Name of the <code>[[WDD|.wdd]]</code> file that contains the ''lod model'' for the defined modelname.
 +
|}
  
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.
+
== Statistics ==
{{Object-Flags}}
+
Total number of ANIM entries in:
 +
:San Andreas: 54
 +
:GTA IV: 158
  
 
== References ==
 
== References ==

Latest revision as of 06:51, 31 May 2019

ANIM (IDE section)
Supported games:San Andreas GTA IV
Brief description:Used to define animated map objects
IDE Sections:
2DFX AMAT ANIM CARS HIER HAND MLO OBJS
PATH PEDS TANM TOBJ TREE TXDP WEAP

ANIM is a section in the item definition file in San Andreas and GTA IV. It is used to define standard map objects linked to an animation. Its format is almost exactly like standard map objects but with one additional parameter for the animation file. GTA IV added a section (TANM) that supports time controlled objects linked to animations.

Format

San Andreas

anim
Id, ModelName, TxdName, AnimationName, DrawDistance, Flags
end
San Andreas Identifier Type Description
A Id integer Unique object ID.
B ModelName string Name of the .dff model file without extension.
C TxdName string Name of the .txd texture dictionary without extension.
D AnimationName string Name of the .ifp animation file without extension.
E DrawDistance float Draw distance in units.
F Flags integer Object flags

Note that animated models still have static collisions. This means that the collision do not animate with the model since it does not contain bone information for the animation. If you want to move objects, you can do this using the script. [1]

GTA IV

anim
ModelName, TxdName, AnimationName, DrawDistance, Flag, unknown, MinX, MinY, MinZ, MaxX, MaxY, MaxZ, SphereX, SphereY, SphereZ, Radius, LODModel
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 AnimationName string Name of the .wad animation file without extension.
D DrawDistance float Draw distance in units.
E Flag integer Object flag
F unknown float Unknown integer (0 by default).
G,H,I MinX, MinY, MinZ float[3] Lower left corner of the bounding box for the object.
J,K,L MaxX, MaxY, MaxZ float[3] Upper right corner of the bounding box for the object.
M,N,O SphereX, SphereY, SphereZ float[3] Center of the bounding sphere for the object.
P Radius float Radius of the bounding sphere into all dimensions.
Q LODModel string Name of the .wdd file that contains the lod model for the defined modelname.

Statistics

Total number of ANIM entries in:

San Andreas: 54
GTA IV: 158

References

See also