Law and order to lua

[impaktor]

Move Law to Lua

This moves the law enforcement from Polit.cpp (which is almost empty now) to lua. I worked on this about 6 months ago, but I got stuck due to a segfault when loading a game, but it seems to have fixed itself now (after updating branch to master).

Update: as of 2015-08 I'm continuing this due to #887 being "fixed".

Changed/New features

Some of the changes in how police will behave now:

1. Police number, and how quickly they react to your crimes (police launch probability) depends on system lawlessness.
2. However, police will not launch until player has amassed high enough fines. I.e. threshold isn't fine = 0 anymore, but maxFineTolerated=1e3
3. Lowered fine on piracy to 1e5, and weapons discharge to 1e2, allowing the latter to be below the maxFineTolerated level.
4. Dumping illegal goods or goods with negative price (close to station) is an offense.
5. Crime record now lists how many of each crime type the player has.
6. Player has two crimerecords for each faction, one with "outstanding fines", and one "Crimerecord" with past history.
7. A police ship destroyed at a station remains so until player hyperjumps back (same as before I believe); i.e. limited number of police ships in station.
8. Police ships are different for different factions. Default: sinonatrix, CIW: pumpkinseed, SolFed: kanara.

Design / Code

I'm not sure about what code to put in which file, i.e. how to structure it. Current structure reflects a lot of the development history during my work on this.

• I've introduced a libs/Legal.Lua that holds the crime constants, and a notifyOfCrime() which was previously in Polit.cpp.
• I've introduced a modules/CrimeTracking to be symmetric with our modules/StatsTracking. It has the event triggers (onShip<ActionX>) for killing, firing, jettison, etc. and it holds the doLawAndOrder() (previously in SpaceStation.cpp).
• libs/Player.lua has a local CrimeRecord class, which the player has two copies of for each faction (current crimes, and past crimes). There are also Player:AddCrime() and such.
• In the old (current master) code, each space station upholds the law (every frame) by calling the function DoLawAndOrder. I could implement it the same way in libs/SpaceStation.lua, but thought it needs only be called once (about every 5 seconds), at which point a check is made to find the closest space station (calls a new method: Ship:GetLawEnforcingStations(), returns stations within "law range"), thus you will not be fined twice for one single illegal action done within range of both stations. (I still have to check the distance of the player to all stations every call.)
• "law range" is a new attribute: Station.lawEnforcedRange (100 km).
• Stations have a SpaceStation:LaunchPolice(targetShip) and Station:LandPolice().

Progress

• 1. Remove all crime handling from c++
• 2. Implement crime handling in Lua (kind of done), closes Move police to Lua #1055
• 3. Crime record shows number of violations of each type
• 4. Police ship set by faction definition, fixes Police ship should not be hardcoded #1237
• 5. Deny launch clearance if player has unpaid fines, fixes Launch clearance #62
• 6. Dumping cargo with negative price (close to station) is a crime, fixes There's no penalty for dumping rubbish or radioactives #873
• 7. Police is launched first after some threshold of illegal actions is passed, closes 3 Strikes Rule for Weapons fire in city limits - Same with Collison Warning #1731
• 8. Crime record in Lua is a class
• 9. Better methods for getting at the player's crimes in the Player.record table?
• 10. Fix frequent crashes when a police ship is dead (onShipHit event can cause crashes #887)
• 11. Implement a Player:ClearCrimeFine, and clean up comments in lib/Player.lua
• 12. Test-test-test: Save/Load when chased by police and killed police and test again
• 13. Moved Crime constants work in translation system
• 14. Store settled crimes in an old crime record and still remember them
• 15. Check natural doc rendering of API documenting strings

For another separate pull request:

When this is merged, I'll be looking into:

1. Label police ships after the police name used by the faction, requires JSON to faction (It is really cool when the launched police is labeled as "Confederate Police" instead of just "Police".) see: Descriptions of home systems are not translatable #2867
2. Fix legal footer, Legal status doesn't work. #2863.
3. Find a better way of compounding fines in NotifyOfCrime. For now: works as it used to.
4. taking off when denied launch clearance is a crime
5. Number of available police ships should depend on station size?
6. Pay fines remotely by F4.
7. IsCommodityLegal should be in lua?

[fluffyfreak]

This looks good, gutting and removing Polit has been on the cards for far too long! :)

[bszlrd]

The two new police ship textures:


This one doesn't have text, because the UVs are mirrored.

[impaktor]

For the record, I've been working on this PR this summer, and have it almost done, (I poked @nozmajner about the police textures, thanks). What remains is just to clean up and push the last code changes from my local computer. I currently have very little time (or at least aught to have), so I'll see when this gets done.

EDIT: I updated the text in my first post a few weeks ago. Number 14 on the to-do list above is done. But to be cleaned and pushed.

[impaktor]

This has been fermenting for over a year now (first commit: 2014 April), and I'm almost approaching issue-1719 status, but now I think I'm ready for this to be reviewed. I don't know how many times I've rebased this, but it's a lot, so the commits should make sense.

I don't expect anyone to read all code, but I would like:

• Please re-read the original top post (I've updated it)
• Please (if you have an opinion) look at the balance or "which-function-goes-where" in the files: libs/Legal.lua, modules/CrimeTracking/CrimeTracking.lua (and libs/Player.lua). My current thinking is that at least Legal.lua and CrimeTracking.lua could be combined or something? @laarmen, @johnbartholomew ?
• If anyone care, play around with it. Specifically, test save/load, jump between factions, and blow up police and save->load.
• Yes, I know the Police screen isn't updated real-time when you pay your fines, one has to go to some other tab then back again. I don't consider it a bug, more a lack-of-feature-I-didn't-care-to-fix. It's all in Lua, so anyone can play around with it.

So 90% of this work (c++ -> lua) is nothing anyone will notice, but at least below is some eye-candy. Hmmm. Or perhaps eye-oatmeal.

I'VE BEEN BAD:

BUT I RIGHTED MY WRONGS:

BUT OLD HABITS DIE HARD:

[fluffyfreak]

Excellent work!

I don't think I can bring myself to stare at any code tonight after doing it all day for work but will try to look into it & testing next week / Sunday.

Everyone else chip in where possible!

[impaktor]

Thanks @fluffyfreak! By the way, we're getting OpenGL errors on the new police ships, I'm guessing you can understand that more easily than me or @nozmajner.

I can add that since now the code is in Lua, it's easy for anyone to play around with how fines should work, how they're accumulated, and also how/when police should be dispatched. I wrote that part over a year ago, and I'm slightly foggy on it, and it can be tweaked later, but since I lowered fine for "unlawful firing" and put a threshold for when police will start shooting at you, you now have to shoot quite a bit to raise the police.

[laarmen]

Baaah, just merge it, get flamed for a week or two by random users while we put out all the fires it started, and get done with it. That's how I did it ;-). Another, slightly less fun idea would be to issue a call for tests on SSC, Twitter, G+ and the dev forum. I dunno who has the setup to produce random win32 builds, but this might prove useful. @robn, @walterar maybe ?

[fluffyfreak]

@impaktor & @nozmajner I think the OpenGL errors are coming from the pumpkinseed_police_diff.dds texture which is 1024x1025 <-- note the "5" instead of a "4" in there.

DDS textures using DXT1, DXT1a or DXT5 must be either power of two, or divisible by 4 in each dimension. So 1028 might be ok, or 1020, but 1025 isn't.

NB: Just to confirm, it is the texture, I resized it locally, recompressed it etc and have tested a few times without the INVALID_ARGUMENT appearing again. @nozmajner just needs to shrink/crop the texture my 1 pixel vertically and make sure that the UV mapping is still correct.

[fluffyfreak]

Also @laarmen might have a good point, we've got until the end of the month so getting more eyeballs on it and then fixing the obvious issues could be one approach.

Or wait until next month and merge right at the start to give maximum time.

So far I've not noticed any problems but I was only looking at the opengl issue thus far. I haven't been able to get the Police to attack me despite shooting at a ground station for a while though.

Will test some more :)

[fluffyfreak]

Ok, I have 278 Unlawful weapon discharge and a $178 fine but no police have come after me yet.

[impaktor]

Yes, so the threshold for launching police is currently 1000, and fine for shooting in Sol is 100, (on New Hope it's 89). I think I should lower the threshold to 300, i.e. a three strike policy for lawlessness = 0 system.

I also agree with letting the players test it, and find the bugs. Ideally, I think it would be good with a "pioneer stable" version, and a "latest" version, my thinking is that the "stable" version is best for new players, since it's a bit of a bummer to try pioneer for the first time and end up with bugs and crashes.

Also, please note: this PR does not include any save-bump commit, so up to the merger to fix that.

Do we know of any other save-bumping code that might pop-up in the near future?

Ok, I have 278 Unlaful weapon discharge and a $178 fine but no police have come after me yet.

I'll look into that, what system?

[fluffyfreak]

Lanner as mod

Rolling contract is kind of what I'm on now too, I expect that it will last until March/April next year but that's only based on what we've discussed there's nothing in writing. Such is life!

Now then the bug: yes I see it even with the latest merged in (hoped for fixes) which is pretty bad.
I don't understand the Lua save system at all unfortunately but I can at least confirm it for you :/

[fluffyfreak]

Is there a way to write to the output log from the Lua save methods so that you can see if they're being recorded/restored? Perhaps figure out where they are themselves called from and put some logging in there to figure out if they are being called, and if they are why they're not saving/restoring.

[impaktor]

I'm not sure my description for reproducing this bug is 100% deterministic. Seems like sometimes it works, sometimes not. I'm printing out debug statements, so I can see the bug happening "real time". I.e. when saving manually the save system always calls the serializer of the lua-class, as it should, and it prints out "...SERIALIZED!" (I've pushed a debug commit). When autosave does a save, it prints out "SAVED ".

So just by doing:

1. save manually
2. exit game,

I can get two different printouts:

without bug triggered:

I get one print from CrimeRecord serializer for each save call (1 manual, 1 from autosave), and then AutoSave notifies me it's been called and saved to a file called _exit.

TradeShips: Removed 0 ships before serialization
...SERIALIZED!
TradeShips: Removed 0 ships before serialization
...SERIALIZED!
...SAVED!   _exit

with bug triggered:

First printout if from my manual save. Second is from AutoSave, but somewhere down the line it failed to call the serializer of the class:

TradeShips: Removed 0 ships before serialization
...SERIALIZED!
TradeShips: Removed 0 ships before serialization
...SAVED!   _exit

So I'm guessing somewhere between LuaGame.cpp and LuaSerializer.cpp something strange is happening. I cant poke this more tonight.

[laarmen]

I'm mostly afk these days, but I'll try to take a look. I had my fair share of battles against this subsystem ;-)

[impaktor]

That would be greatly appreciated @laarmen, because I'm at a loss here!

It might be interesting to also have debug printout for the Equipment serialization, since that might also have the bug, and if it doesn't then that's narrowed it down further. My CrimeRecord class is, as of my recent fix of the bug fluffy found, basically just an exact copy of your Equipment implementation.

[johnbartholomew]

Best guess about the bug is that it's because both the AutoSave module and the Player module have registered handlers for the "onGameEnd" event. The Player module onGameEnd handler clears out the player's data -- if that runs before AutoSave onGameEnd then the _exit save will have no crime record.

Should be fairly easy to fix -- don't try to clean up any state in onGameEnd; instead, reset the state in onGameStart (and then inject anything needed from loaded_data). It's not a very nice system, but should work ok.

[impaktor]

I believe you are as usual, spot on!

And as usual, I was way off. (How come I always look for bugs in the wrong place... until I find it? 😜 )

I've put a printout in OnGameEnd and indeed it is called before the autosave, which then has no CrimeRecord object to serialize. (with the printout I can't seem to get the bug not to happen, to really make sure they're called in the opposite order)

[impaktor]

Rebased (probably for the +40th time), and cleaned/squashed up previous fixes, (except for the last one, since that commit would have to be split in two and then each part merged into two different commits, and I don't feel much like doing that).

So, to the best of my knowledge, this PR is now done.