Here's ours from IW. I documented it as best I could from reading the source. However, it looks like I last messed with this file in late 2008 so the information might be outdated and there is likely new stuff by now.
Code:
local modrules = { reclaim = { multiReclaim = false, -- boolean - allow only 1 or >1 unit to simultaneously reclaim a feature/corpse unitMethod = 1, -- int, 1 unitEnergyCostFactor = 0, -- float, 0 unitEfficiency = 1, -- float, 1 featureEnergyCostFactor = 0, -- float, 0 allowEnemies = true, -- bool, true allowAllies = true, -- bool, true reclaimMethod = 0, -- 0 is gradual reclaim (ie a small % is reclaimed every tick) -- 1 is current behaviour - ie one large hit of resources at the end of the reclim period -- >1 is chunky behaviour - reclaim happens in n equal sized chunks }, repair = { energyCostFactor = 0.75, -- how much of the original cost it requires to repair something. }, resurrect = { energyCostFactor = 0.5, -- default: 0.5 }, capture = { energyCostFactor = 0, -- default: 0 }, transportability = { transportGround = true, -- defaults to true --Can [x] units be transported? transportHover = true, -- defaults to false transportShip = false, -- defaults to false transportAir = true, -- defaults to false }, flankingbonus = { defaultMode=0, -- defaults to 1 }, -- 0: no flanking bonus -- 1: global coords, mobile -- 2: unit coords, mobile -- 3: unit coords, locked
experience = { experienceMult = 1.0, -- defaults to 1.0
-- these are all used in the following form: -- value = defValue * (1 + (scale * (exp / (exp + 1))))
In every mod I've seen so far this file seems to have been copied from another mod. But where is the documentation on what everything means?
Any specific questions?
Quote:
I'd also look at CA's modrules file since they're probably more up to date.
Last time I checked it was complete, I even added stuff set to default values (because people look at CA first). I used rts/Sim/Misc/ModInfo.* as reference, it doesn't really have much more comments.
Edit: typo
Last edited by SirMaverick on 11 Sep 2010, 15:09, edited 1 time in total.
The comments in the the above mentioned examples tell you what values are allowed. They don't tell you what the values do.
Some may be obvious, others not. For example flankingBonus requires an understanding of how the engine handles flanking (and knowing what flanking even means in a global context). You need to know how mip levels relate to line of sight. Understanding reclaim and nanospray requires a knowledge of Total Annihilation.
Are both files even complete lists?
Anyway I don't have any specific question except where is the documentation? Is there a specific file in the source code where these things have further explanation or has it been assumed everybody knows what they mean?
If I have any specific question it's whether or not this file is required. I didn't have it and spring crashed expecting a table to be returned. Can I return an empty table? Many of these values are meaningless to my game. I'd rather leave out what I don't need to keep the mod 'clean'.
I don't mean to come off as whiney, I expect there actually isn't any documentation, I'm just urging Spring devs to document these changes as they move things out of the engine or we'll end up with thousands of meaningless configuration options that get set through trial and error. That's no way to make a game.
If I have any specific question it's whether or not this file is required. I didn't have it and spring crashed expecting a table to be returned. Can I return an empty table? Many of these values are meaningless to my game. I'd rather leave out what I don't need to keep the mod 'clean'.
Shouldn't do that in 0.82+. This works fine for me:
As I wrote CA's list seems complete. Source code hasn't changed after last time I checked.
Quote:
Anyway I don't have any specific question except where is the documentation?
Afaik no further documentation.
Quote:
If I have any specific question it's whether or not this file is required. I didn't have it and spring crashed expecting a table to be returned. Can I return an empty table? Many of these values are meaningless to my game. I'd rather leave out what I don't need to keep the mod 'clean'.
Users browsing this forum: No registered users and 1 guest
You cannot post new topics in this forum You cannot reply to topics in this forum You cannot edit your posts in this forum You cannot delete your posts in this forum You cannot post attachments in this forum