Difference between revisions of "PATH"

From GTAMods Wiki
Jump to navigation Jump to search
m (moved PATH to Paths (Vice City): There is actually content on this page now and it is specifically for Vice City.)
(added images)
 
(39 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Introduction ==
+
{{IplSection
 +
| game        = {{Icon|VC}}
 +
| description = Used to define paths for traffic
 +
}}
 +
'''PATH''' is a section in the [[item placement]] file in [[Vice City]]. It is used to define paths for traffic. Paths are grouped into nodes, each with at most 12 sub-nodes. The group nodes define the type of vehicle going to be used by the sub nodes. Sub nodes contain path coordinates which are linked to each other. There are two kinds of links:
 +
* internal links – connecting nodes within the same group.
 +
* external links – connecting nodes over two different groups.
  
Paths in Vice City are grouped into nodes, each with at most 12 sub-nodes. The Group nodes define the type of vehicle going to be used by the sub nodes. Sub nodes contain path coordinates which are linked to each other both internally(Inside the group) and externally(Outside the group with other group nodes).
+
== Format ==
 +
{{Pre|
 +
path
 +
GroupType, -1
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
 +
end
 +
}}
  
 
+
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
== How Vice City Stores a Line (Linear path) ==
+
! style="width: 3em;"| {{Icon|VC}}
 
+
! style="width: 12em;"| Identifier
 
+
! style="width: 6em;" | Type
First of all, consider a small segment of the line in a group node. The group node has to be defined and then there are the 12 sub-nodes inside it. The number of coordinates vary from 2 to 12. If the number of coordinates does not reach 12, then they are filled with null nodes which does not do anything just to make the group node hold always 12 nodes. The internal and external sub nodes are defined each with a special attribute in it. The internal sub nodes are the middle parts of a segment of the line, while the external sub nodes are the end points of the segment of the line. They are used to connect to other external sub-node or end point of another segment(Another group) of the line. To connect the external sub-nodes or end points, they must and always must have the same coordinates. All the other group nodes link up together using this concept, thus you get a path which a vehicle or a ped follows from the beginning and to the end of the line.
+
! Description
Spawns are made in the external nodes (Always remember that fact) and then they follow the route of the line.
+
|-
 
+
! colspan="4" | Group
One can add a maximum of 24 group nodes in Vice City though this limit can be increased by Maxorator's Path hacks.
+
|-
 
+
| A || GroupType || integer ||
== Flags ==
+
* ''0'' = Pedestrian traffic
 
+
* ''1'' = Road traffic
The last three numbers at the end of a paths line are the Flags, each ones can define a special function.
+
* ''2'' = Water traffic
 
+
|-
 
+
| B || -1 || integer || always ''-1'', used as a delimiter
 
+
|-
'''Flag 1, Node Speed Limit'''
+
! colspan="4" | Node
 
+
|-
Flag 1 has been identified as a Speed function, that is it specifies the speed vehicles will travel along that Path/Node.
+
| A || NodeType || integer ||
{| {{Prettytable}}
+
* ''0'' = Null
|0 || Slow Vehicle Speed
+
* ''1'' = External
 +
* ''2'' = Internal
 +
|-
 +
| B || NextNode || integer ||
 +
* ''-1'' = Do not link to any other node in this group
 +
* ''0'' to ''11'' = Link to this node number in this group
 +
|-
 +
| C || IsCrossRoad || integer || Boolean determining if there is a cross road in the imaginary line joined by two nodes
 +
|-
 +
| D,E,F || X, Y, Z || float[3] || X, Y, Z coordinates of the node * 16
 +
|-
 +
| G || Median || float ||
 +
* Pedestrian traffic: width of walkway
 +
* Road traffic: width of divider between left and right lanes.
 +
|-
 +
| H || LeftLanes || integer || Number of lanes left of the node. This is ignored for internal nodes
 +
|-
 +
| I || RightLanes || integer || Number of lanes right of the node. This is ignored for internal nodes
 +
|-
 +
| J || SpeedLimit || integer || Sets the speed of vehicles traveling through the path
 +
* ''0'' = Slow
 +
* ''1'' = Medium
 +
* ''2'' = Fast
 
|-
 
|-
|1 || Average Vehicle Speed
+
| K || Flags || integer || General node behavior
 +
* ''0'' = No flags
 +
* ''1'' = Ignored by traffic
 +
* ''2'' = Police roadblock (only for road traffic node)
 +
* ''4'' = Restricted node
 +
* ''8'' = No effect, may be used by water traffic to increase maneuverability
 
|-
 
|-
|2 || Fast Vehicle Speed
+
| L || SpawnRate || float || Spawn rate frequency ranging from ''0.0'' to ''1.0''
 
|}
 
|}
  
'''Flag 2, Vehicle Travel/Roadblock'''
+
== Description ==
 +
[[File:Vc car paths.png|thumb|200px|Car Paths Visualization]]
 +
[[File:Vc ped paths.png|thumb|200px|Ped Paths Visualization]]
 +
Consider a small segment of the line in vehicle paths node. The group has to be defined and then there must be 12 nodes inside it. If the total number of internal and external nodes in a group is not 12, then the remaining should be filled with null nodes.
  
Flag 2 has been identified as a controller for where some vehicle can travel and where Police Roadblock will spawn.
+
The internal nodes define the connections inside the group whereas the external nodes define the connections to other group. External nodes in a group are connected to other external nodes in different group external sub-nodes by having the same coordinates.  
  
Note, Police Roadblock will only work if it is a Vehicle node with that Flag.
+
Spawns are always made in internal nodes, and external nodes only act as a link. For vehicles, lane information and the median width inside internal nodes are ignored, those information are only retrieved from external nodes. And also for vehicles, junctions are always kept in a separate group and external nodes of the group must always point to beginning of a connected line segment, whereas pedestrian nodes can mix the two.
  
Note, Specified Vehicles Only, means that only Vehicles with a Specified flag will use the Paths.
+
One can add a maximum of 4 paths group in Vice City though this limit can be increased by Maxorator's Path hacks. {{ref|1}}
{| {{Prettytable}}
 
|0 || Flag Ignored
 
|-
 
|1 || Vehicles Wont Use/Spawn
 
|-
 
|2 || Police Roadblock Spawns
 
|-
 
|4 || Specified Vehicles Only
 
|-
 
|8 || (Unknown Purpose)
 
|}
 
  
 +
== Tools and scripts ==
 +
* {{GTAF|490426|In-Game Paths Maker}} – by {{U|Swoorup}}
 +
* {{note|1}} [http://almost610.dmon.com/load/other/vc_paths_multiplier/2-1-0-16 Maxorator's Path Limit Hack] – by {{GTAF|profile|146289|Maxorator}}
  
Setup of a VC Paths Line
+
== External links ==
{| {{Prettytable}}
+
* [http://projectcerbera.com/gta/vc/tutorials/paths Description of the Vice City paths format] – by {{U|Cerbera}}
|Path Type, Joins to Node _, 0, X, Y, Z, Median, Left, Right, Flag1, Flag2, Flag3
+
* {{GTAF|490426|In-Game Paths Maker for VC}} – by {{U|Swoorup}}
|}
+
* {{GTAF|post|93990|4027008|Flags description}} – by {{U|AK-73}}
 +
* {{GTAF|post|93990|1856773|Statistics for paths.ipl}} – by {{U|Steve-m}}
 +
{{N|VC}}

Latest revision as of 18:50, 22 May 2019

PATH (IPL section)
Short description:Used to define paths for traffic
Supported games:Vice City
IPL Sections:
2DFX AUZO BLOK CARS CULL ENEX GRGE
INST JUMP LINK LODM MLO+ MULT OCCL
PATH PICK RTFX SLOW TCYC VNOD ZONE

PATH is a section in the item placement file in Vice City. It is used to define paths for traffic. Paths are grouped into nodes, each with at most 12 sub-nodes. The group nodes define the type of vehicle going to be used by the sub nodes. Sub nodes contain path coordinates which are linked to each other. There are two kinds of links:

  • internal links – connecting nodes within the same group.
  • external links – connecting nodes over two different groups.

Format

path
GroupType, -1
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
	NodeType, NextNode, IsCrossRoad, X, Y, Z, Median, LeftLanes, RightLanes, SpeedLimit, Flags, SpawnRate
end
Vice City Identifier Type Description
Group
A GroupType integer
  • 0 = Pedestrian traffic
  • 1 = Road traffic
  • 2 = Water traffic
B -1 integer always -1, used as a delimiter
Node
A NodeType integer
  • 0 = Null
  • 1 = External
  • 2 = Internal
B NextNode integer
  • -1 = Do not link to any other node in this group
  • 0 to 11 = Link to this node number in this group
C IsCrossRoad integer Boolean determining if there is a cross road in the imaginary line joined by two nodes
D,E,F X, Y, Z float[3] X, Y, Z coordinates of the node * 16
G Median float
  • Pedestrian traffic: width of walkway
  • Road traffic: width of divider between left and right lanes.
H LeftLanes integer Number of lanes left of the node. This is ignored for internal nodes
I RightLanes integer Number of lanes right of the node. This is ignored for internal nodes
J SpeedLimit integer Sets the speed of vehicles traveling through the path
  • 0 = Slow
  • 1 = Medium
  • 2 = Fast
K Flags integer General node behavior
  • 0 = No flags
  • 1 = Ignored by traffic
  • 2 = Police roadblock (only for road traffic node)
  • 4 = Restricted node
  • 8 = No effect, may be used by water traffic to increase maneuverability
L SpawnRate float Spawn rate frequency ranging from 0.0 to 1.0

Description

Car Paths Visualization
Ped Paths Visualization

Consider a small segment of the line in vehicle paths node. The group has to be defined and then there must be 12 nodes inside it. If the total number of internal and external nodes in a group is not 12, then the remaining should be filled with null nodes.

The internal nodes define the connections inside the group whereas the external nodes define the connections to other group. External nodes in a group are connected to other external nodes in different group external sub-nodes by having the same coordinates.

Spawns are always made in internal nodes, and external nodes only act as a link. For vehicles, lane information and the median width inside internal nodes are ignored, those information are only retrieved from external nodes. And also for vehicles, junctions are always kept in a separate group and external nodes of the group must always point to beginning of a connected line segment, whereas pedestrian nodes can mix the two.

One can add a maximum of 4 paths group in Vice City though this limit can be increased by Maxorator's Path hacks. [1]

Tools and scripts

External links