Difference between revisions of "OCCL"

From GTAMods Wiki
Jump to navigation Jump to search
m (Occlusion moved to OCCL over redirect: as requested at Talk:Occlusion)
m
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Cleanup-rewrite}}
 
 
{{IplSection
 
{{IplSection
−
| name       = OCCL
+
| game       = {{Icon|VC}} {{Icon|SA}} {{Icon|4}}
−
| game        = [[GTA VC]], [[GTA SA]], [[GTA IV]]
+
| description = Creates occlusion culling zones
−
| description = Creates zones for separated rendering
 
 
}}
 
}}
−
'''OCCL''' is a section in the [[IPL]] file that helps make the game run smoother in certain parts of the map. The occlusions are created using invisible boxes. These boxes disable models that are behind the boxes from rendering. This feature is not really effective and Rockstar did not use this feature efficiently. There are not much improvements on occlusions in San Andreas compared to Vice City. Deleting all entries in the occlu section does not have any major effects on the game.
+
'''OCCL''' is a section in the [[item placement]] file in [[Vice City]], [[San Andreas]], and [[GTA IV]]. It is used to create [[wikipedia:Hidden surface determination|occlusion culling]] zones that helps make the game run smoother in certain parts of the world. Since it is wasteful to render models behind opaque models, these zones can disable the rendering of any models that are directly behind the zones.
  
−
==Location==
+
== Format ==
−
Occlusions are controlled by the <code>occl</code> section of the [[IPL]] files. Rockstar created the occlusions through the <code>occlu.ipl</code> in Vice City and the <code>occlu.ipl</code>, <code>occluint.ipl</code>, <code>occluLA.ipl</code>, <code>occlusf.ipl</code>, and the <code>occluveg.ipl</code> in San Andreas. You can open these files using Microsoft Notepad. You do not need to use these files to create your own occlusions as long as the entry is in a defined IPL file.
+
=== Vice City ===
 +
[[File:VC occlu.jpg|thumb|A map of Vice City's <code>occlu.ipl</code> areas]]
 +
{{Pre|
 +
occl
 +
MidX, MidY, BottomZ, WidthX, WidthY, Height, Rotation
 +
end
 +
}}
  
−
==Format==
+
The section is used in the <code>occlu.ipl</code> file but it can be used in any IPL files.
−
mid x, mid y, bottom height z, width x, width y, height from bottom height to top, rotation
+
{|class="wikitable center-col-1 center-col-2"
−
{|{{Prettytable}} width="100%" class="collapsible"
+
!style="width: 3em;"|{{Icon|VC}}
−
!width="250px"|Identifier
+
!style="width: 12em;"|Identifier
 +
!style="width: 6em;" |Type
 
!Description
 
!Description
 
|-
 
|-
−
|<center>mid x, mid y</center>||The middle of the occlusion box in X and Y coordinates.
+
|A,B ||MidX, MidY ||float[2] ||The X and Y coordinates of the center of the occlusion zone.
 
|-
 
|-
−
|<center>bottom height z</center>||The bottom Z coordinate of the occlusion box.
+
|C ||BottomZ ||float ||The bottom Z coordinate of the occlusion zone.
 
|-
 
|-
−
|<center>width x, width y</center>||The width of the occlusion box in units.
+
|D,E ||WidthX, WidthY ||float[2] ||The width of the occlusion zone in units.
 
|-
 
|-
−
|<center>height from bottom height to top</center>||The difference in height from the top of the occlusion box to the bottom.
+
|F ||Height ||float ||The height of the zone &mdash; the difference between the top and the bottom of the zone.
 
|-
 
|-
−
|<center>rotation</center>||The rotation of the occlusion box in angles.
+
|G ||Rotation ||float ||The [[Angle|rotation]] of the occlusion zone in degrees.
 
|}
 
|}
  
−
==Viewing It==
+
=== San Andreas ===
−
Vice City's occlusions can only be viewed through [[KEd]]. KEd sees occlusion boxes as green, transparent boxes with a small triangular hole in the 3D View. KEd does not support editing the occlusions through the program so you have to create the boxes yourself.
+
The section is used in <code>occluint.ipl</code>, <code>occluLA.ipl</code>, <code>occlusf.ipl</code>, and <code>occluveg.ipl</code> files.
  
−
For San Andreas you can use {{U|Deniska}}'s script pack {{ref|1}} that contains an small tool to import and export the occlusion section of the [[IPL]]
+
{{Pre|
−
 
+
occl
−
[[Image:Occlusion.png|center|frame|Occlusion boxes in KEd]]
+
MidX, MidY, BottomZ, WidthX, WidthY, Height, Rotation, , ,
−
 
+
end
−
==Creating It==
+
}}
−
The following way to make occlusion boxes is practiced by [[User:spaceeinstein|spaceeinstein]]. First find a building that you want to make occlusion boxes and align it to the X- and Y-axis. Get the coordinates of the lower left corner of the building and the upper right corner of the building. The coordinates for the lower left and upper right corner of the building can be inputted as X1, Y1, and Z1, and X2, Y1, and Z2, respectively, into the occlusion tool. If you are not bothered to get the lower Z coordinate of the box, you can input any number that is lower than the foundation of your building. Making the boxes with angles is pretty tough to do and probably needs some trial and error to fit it into the building.
+
{|class="wikitable center-col-1 center-col-2"
 +
!style="width: 3em;"|{{Icon|SA}}
 +
!style="width: 12em;"|Identifier
 +
!style="width: 6em;" |Type
 +
!Description
 +
|-
 +
|A,B ||MidX, MidY ||float[2] ||The X and Y coordinates of the center of the occlusion zone.
 +
|-
 +
|C ||BottomZ ||float ||The bottom Z coordinate of the occlusion zone.
 +
|-
 +
|D,E ||WidthX, WidthY ||float[2] ||The width of the occlusion zone in units.
 +
|-
 +
|F ||Height ||float ||The height of the zone &mdash; the difference between the top and the bottom of the zone.
 +
|-
 +
|G ||Rotation ||float ||The [[Angle|rotation]] of the occlusion zone in degrees.
 +
|-
 +
|H,I || ||float ||
 +
|-
 +
|J || ||int ||
 +
|}
  
−
Using {{U|Deniska}}'s script {{ref|1}} you need only to create a box, press the Export button on the script and paste the line from the MAXScript listener to the [[IPL]] section.
+
== Issues ==
 +
When removing buildings from the world, you may see unexpected pop ups caused by existing occlusion zones. Deleting all the occlusion zones is the easiest solution. An example of this issue is the Liberty City project. Before this section was researched, the team experienced unexpected pop ups with models loading and unloading behind areas where Vice City's buildings used to be. Someone realized that the <code>occlu.ipl</code> was the problem and deleted every line in that file. The pop ups disappeared and the issue was resolved.
  
−
==Problems==
+
== Statistics ==
−
If you delete the buildings in Vice City or San Andreas without deleting the occlusions, you would see pop ups behind the occlusions. These occlusions had created problems for a few modifications, most notably in the Liberty City modification. In the Liberty City mod, the team experienced unexpected pop ups caused by the occlusion boxes. These boxes are loading and unloading the models behind boxes where Vice City's buildings used to be at. Someone realized that the <code>occlu.ipl</code> was the problem and deleted every line in that file. The pop ups disappeared.
+
Total number of OCCL entries in:
 +
:Vice City: 344 (max 350)
  
−
==Tools & Scripts==
+
== Tools and scripts ==
 
* [[KEd]] &ndash; by {{U|JernejL}}
 
* [[KEd]] &ndash; by {{U|JernejL}}
−
* {{note|1}} {{GTAF|277798|Script pack for 3ds Max}} &ndash; by {{U|Deniska}}
+
* {{GTAF|277798|Script pack for 3ds Max}} &ndash; by {{U|Deniska}}
−
* {{GTAF|402942|(SA and IV) Occlu-IO in GTA-IV script centre}} &ndash; by {{U|Gforce}}
+
* {{GTAF|402942|&#91;IV&#93;&#91;Rel&#93;GTA-IV Scripts Centre}} &ndash; by {{U|Gforce}}
  
−
{{N|4|SA}}
+
{{N|4|SA|VC}}
−
[[Category:Map Formats]][[Category:GTA VC]]
+
[[Category:Map Formats]]

Latest revision as of 18:40, 10 November 2016

OCCL (IPL section)
Short description:Creates occlusion culling zones
Supported games:Vice City San Andreas GTA IV
IPL Sections:
2DFX • AUZO • BLOK • CARS • CULL • ENEX • GRGE
INST • JUMP • LINK • LODM • MLO+ • MULT • OCCL
PATH • PICK • RTFX • SLOW • TCYC • VNOD • ZONE

OCCL is a section in the item placement file in Vice City, San Andreas, and GTA IV. It is used to create occlusion culling zones that helps make the game run smoother in certain parts of the world. Since it is wasteful to render models behind opaque models, these zones can disable the rendering of any models that are directly behind the zones.

Format

Vice City

A map of Vice City's occlu.ipl areas
occl
MidX, MidY, BottomZ, WidthX, WidthY, Height, Rotation
end

The section is used in the occlu.ipl file but it can be used in any IPL files.

Vice City Identifier Type Description
A,B MidX, MidY float[2] The X and Y coordinates of the center of the occlusion zone.
C BottomZ float The bottom Z coordinate of the occlusion zone.
D,E WidthX, WidthY float[2] The width of the occlusion zone in units.
F Height float The height of the zone — the difference between the top and the bottom of the zone.
G Rotation float The rotation of the occlusion zone in degrees.

San Andreas

The section is used in occluint.ipl, occluLA.ipl, occlusf.ipl, and occluveg.ipl files. 

occl
MidX, MidY, BottomZ, WidthX, WidthY, Height, Rotation, , ,
end
San Andreas Identifier Type Description
A,B MidX, MidY float[2] The X and Y coordinates of the center of the occlusion zone.
C BottomZ float The bottom Z coordinate of the occlusion zone.
D,E WidthX, WidthY float[2] The width of the occlusion zone in units.
F Height float The height of the zone — the difference between the top and the bottom of the zone.
G Rotation float The rotation of the occlusion zone in degrees.
H,I float
J int

Issues

When removing buildings from the world, you may see unexpected pop ups caused by existing occlusion zones. Deleting all the occlusion zones is the easiest solution. An example of this issue is the Liberty City project. Before this section was researched, the team experienced unexpected pop ups with models loading and unloading behind areas where Vice City's buildings used to be. Someone realized that the occlu.ipl was the problem and deleted every line in that file. The pop ups disappeared and the issue was resolved.

Statistics

Total number of OCCL entries in:

Vice City: 344 (max 350)

Tools and scripts

v · d · e
GTA IV Grand Theft Auto IV
File Formats.dat • .gxt • .ide • .img • .ipl • .nod • .sco • .rpf • .rrr • .wad • .wbd/.wbn • .wdd • .wdr • .wft • .whm • .wpl • .wtd
DocumentationAudio • Bink Video • Cryptography • Cutscenes • GXT Text • Image listing • Keycodes • Map Listing • Native functions • Paths • Radar Blips • Radio Stations • Saves • Scenarios • VTable • Weapons
ToolsASI Loader • ENBSeries • G-Texture • GIMS IV • Ingame WPL Editor • IV Needle • OpenIV • SparkIV • XLiveLess • WPL Manager • X Mod Installer
Alice • C++ Script Hook • .NET Script Hook • Scocl
TutorialsImporting Textures with OpenIV • Importing Textures with SparkIV
ModificationsGTA Connected • Gostown IV • Four Multiplayer • IV Multiplayer • CitizenMP:IV Reloaded
Useful linksCommunity portal • Discussion forums • Modding forums • Mods on GTAGarage.com
v · d · e
San Andreas Grand Theft Auto: San Andreas
File Formats.b • .col • .cfg • .cut • .dff • .dat • .fxp • .gxt • .ide • .ifp • .img • .ipl • nodes*.dat • .ped • .rep • .rrr • .scm • .set • .txd
DocumentationAudio • Cryptography • Cutscenes • Game memory • Handling.cfg • Map Listing • Mission Packs • Instructions • Paths • Replays • Saves • Scripts • Sound Effects • Statistics • Vehicles • Wanted levels
ToolsCLEO • Collision File Editor II • ENBSeries • G-Tools • IMG Tool • Limit Adjuster • Map Editor • Mod Loader • San Andreas Audio Toolkit • Sanny Builder • TXD Workshop • Magic.TXD
TutorialsSan Andreas v2.0 Modding • How to create a mission • How to create a script • How to use Map Editor • Vehicle Mod Installation
ModificationsDesign Your Own Mission • Gostown Paradise • GTA: United • Myriad Islands
MultiplayergtaTournament • Multi Theft Auto • San Andreas Multiplayer • (more...)
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
v · d · e
Vice City Grand Theft Auto: Vice City
File Formats.adf • .b • .col • .cfg • .dff • .dat • .gxt • .ide • .ifp • .img/.dir • .ipl • .raw/.sdt • .rep • .set • .scm • .txd
DocumentationAudio • Handling • Map Listing • Memory Addresses • Skin List • Opcodes • RenderWare • Script Paths • Saves • Sound Effects • Statistics • Vehicles • Text • Wanted levels • Weapons
ToolsCLEO • Collision File Editor II • G-Tools • GXT Editor • IMG Tool • Limit Adjuster • KEd (map editor) • Sanny Builder • TXD Workshop • Magic.TXD
TutorialsHow to create a mission • How to create a script • Vehicle Mod Installation
MultiplayerGTA:LC Multiplayer • gtaTournament • Multi Theft Auto • State Of Liberty Online • Vice City Multiplayer • Vice City Online
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
Retrieved from "https://gtamods.com/mediawiki/index.php?title=OCCL&oldid=16258"