yapf.txt
author bjarni
Thu, 05 Oct 2006 12:59:28 +0000
changeset 4739 e626ef1b522e
parent 3971 77061ae9b534
permissions -rw-r--r--
(svn r6651) -Coding feature: added the windowevent WE_INVALIDATE_DATA
This gives the ability to invalidate some window data and recalculate as needed instead of doing it for each WE_PAINT

This event is called right away when using InvalidateWindowData(), so it may be a good idea to set a bool or similar in the window
or similar and then act on that bool in WE_PAINT instead of doing a lot of stuff in WE_INVALIDATE_DATA as it might be called more than once before WE_PAINT is called

InvalidateWindowData() will not automatically repaint the window, so if you want to repaint it as well, you need to mark it dirty as well.

Made the depot windows use WE_INVALIDATE_DATA to set when to generate the engine and wagon lists instead of at each redraw
It makes no sense to regenerate the list when say using the scrollbar if we know that no vehicle have entered or left the list

NOTE: currently there is a piece of code to generate the list when it's not needed and compare it to the stored list and assert if they mismatch
This check is somewhat slow and kills the whole idea of WE_INVALIDATE_DATA, so it's a short lived one to verify that InvalidateWindowData() is used everywhere where it's needed
Ships:
======
Set the YAPF (Yet Another Path Finder) type in the "Configure Pathes/Vehicles/YAPF for ships":
 - 0 - No YAPF (NPF or old PF)
 - 1 - YAPF type 1 (Node = Tile/Trackdir, 90 deg. turns allowed)
 - 2 - YAPF type 2 (Node = Tile/ExitDir , 90 deg. turns allowed)
 - 3 - YAPF type 3 (Node = Tile/Trackdir, no 90 deg.)
 - 4 - YAPF type 4 (Node = Tile/ExitDir , no 90 deg.)


Set the "npf_max_search_nodes" value in your openttd.cfg to tune the pathfinder behavior.
This value tells, how many nodes (Tile/Trackdir or Tile/ExitDir) combinations the pathfinder
should visit before it ends. The lower number would mean quicker, but less accurate results.
The "npf_max_search_nodes" value is shared between NPF and YAPF and has the same meaning.

The pathfinder without such limit would be unusable on large maps, where number of visited
nodes can exceed 10 milions. NPF on my machine (dual code AMD 4400+) with 1 milion of nodes
visited took 2 minutes to finish, but with this limit set to 10000 it takes 20 miliseconds.
The new YAPF had similar results (18 seconds vs. 4 miliseconds).


Road Vehicles:
==============
Set the YAPF (Yet Another Path Finder) type in the "Configure Pathes/Vehicles/YAPF for road vehs":
 - 0 - No YAPF (NPF or old PF)
 - 1 - YAPF type 1 (Node = Tile/Trackdir, 90 deg. turns allowed)
 - 2 - YAPF type 2 (Node = Tile/ExitDir , 90 deg. turns allowed)

Trains:
=======
Same types as for ships:
 - 0 - No YAPF (NPF or old PF)
 - 1 - YAPF type 1 (Node = Tile/Trackdir, 90 deg. turns allowed)
 - 2 - YAPF type 2 (Node = Tile/ExitDir , 90 deg. turns allowed)
 - 3 - YAPF type 3 (Node = Tile/Trackdir, no 90 deg.)
 - 4 - YAPF type 4 (Node = Tile/ExitDir , no 90 deg.)