1dot13/source
1
0
Fork 0
mirror of https://github.com/1dot13/source.git synced 2026-08-05 14:00:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

************************************************************

Browse Source 
* Merged GameDir from Development Trunk: Revision 4063 *
************************************************************
- Merged from SVN: https://81.169.133.124/source/ja2/branches/Wanne/JA2%201.13%20MP

git-svn-id: https://ja2svn.mooo.com/source/ja2_v1.13_data@1257 4f8fa57e-7814-0410-bad4-adc449f26b7c
This commit is contained in:
Wanne
2011-01-18 10:24:49 +00:00
parent 826c4a2590
commit 0a62ebd22b
3975 changed files with 201787 additions and 67273 deletions
Download Patch File Download Diff File Expand all files Collapse all files
gamedir/Data/Scripts/initunderground.lua
+429 -156
View File
@@ -1,17 +1,52 @@
-----------------------
-- Set some stuff up --
-----------------------
-- Initialize the pseudo random number generator
math.randomseed( os.time() ); math.random(); math.random(); math.random()
-- http://lua-users.org/wiki/MathLibraryTutorial
--[[
REMARKS
=======
December 27, 2010
TOC
===
Preamble
§0. Constants
§1. Underground sector list compilation
§2. Defining enemy garrisons and creature population
§3. Internal workings
§3.1. Underground sector names
Preamble
========
This script sets up and initializes underground sectors. It defines where
underground sectors are located on the map, what enemy garrisons and
creature population they feature, and what loading screen to present to
the player.
Sector definitions are read whenever a new game starts. They are then
stored within the savegame meaning various changes to this script don't
have an effect on a game in progress.
Modders likely want to focus on §1. and §2.
There is also another script closely related to this one, which defines
sector names ("undergroundsectornames.lua" and localized versions). See
§3.1. for more details.
The game will call this script for any of three reasons:
1. When a new game starts it will call 'BuildUndergroundSectorList' in
order to create and initialize the array of underground sectors.
2. The game will call 'GetLoadscreen' whenever an underground sector
needs to be loaded.
3. When the game requests an underground sector name it will call
'GetSectorName'.
Remarks
- Several vanilla JA2 sectors may be unsafe to remove due to hardcoded
behaviour such as creature spreading, Deidranna escaping or other quest
@@ -19,172 +54,410 @@ math.randomseed( os.time() ); math.random(); math.random(); math.random()
- Contrary to random number generators used in JA2, Lua's math.random
function includes the range boundaries. Also, indexing in Lua starts at
1 as opposed to C (starting at 0). Find further information about Lua at
http://www.lua.org/docs.html
- Global variables:
- difficultyLevel
1: easy, 2: experienced, 3: expert, 4: insane
- gameStyle
0: realistic, 1: scifi
- To add an underground sector to the list, create a table and pass it as
an argument to addSector function. These tables may consist of the
following members:
- location (required)
string of the form "[R][C]-[L]", where [R] is a row
identifier (A-P), [C] is a column identifier (1-16), [L] is a
sublevel identifier (1-3), e.g. "A9-1"
- numAdmins
- numTroops
- numElites
integers, specifying numbers of enemy garrisons, default: 0
- numBloodcats
integer, specifying quantity of bloodcat population, default: 0
This requires bloodcat placements to be set.
- numCreatures
integer, specifying number of creatures in total, default: 0
Distribution of creature types depends on creature habitat (see below)
- creatureHabitat
integer, specifying creature distribution type
Use one of the constants below (also featuring details).
1 as opposed to C (starting at 0). For further information about Lua
consult the Lua documentation at http://www.lua.org/docs.html
]]
Habitat = { -- creature type distribution in percentages
-- young young adult adult
-- larvae infants male female male female
QueenLair = 0, -- 20 40 0 0 30 10
Lair = 1, -- 15 35 10 5 25 10
LairEntrance = 2, -- 0 15 30 10 35 10
InnerMine = 3, -- 0 0 20 40 10 30
OuterMine = 4, -- 0 0 10 65 5 20
MineExit = 6, -- 0 0 10 65 5 20
-- For debugging purposes you might want to have some basic logging output
-- from the game. Uncommenting the following line will create
-- "initunderground.log" in your profile directory.
--logging = true
-- Initialize the pseudo random number generator
math.randomseed( os.time() ); math.random(); math.random(); math.random()
-- http://lua-users.org/wiki/MathLibraryTutorial
-------------------
-- §0. Constants --
-------------------
Habitat = { -- creature type distribution in percentages
-- young young adult adult
-- larvae infants male female male female
QueenLair = 0, -- 20 40 0 0 30 10 (default)
Lair = 1, -- 15 35 10 5 25 10
LairEntrance = 2, -- 0 15 30 10 35 10
InnerMine = 3, -- 0 0 20 40 10 30
OuterMine = 4, -- 0 0 10 65 5 20
FeedingGrounds = 5, -- - - - - - - (unused)
MineExit = 6, -- 0 0 10 65 5 20
}
CreatureMusic = {
Compat = 0, -- default, use creepy music in the presence of creatures
-- or blue lights (default, also vanilla default);
Auto = 1, -- use creepy music if and only if there any creatures
-- present (ignoring lights);
Never = 2, -- do not use creepy music, regardless of any creatures;
Always = 3, -- do use creepy music, regardless of any creatures
}
---------------------------------------------
-- §1. Underground sector list compilation --
---------------------------------------------
--[[
In this list add underground sectors by specifying their location.
If no loadscreen attribute is given the script will use "LS_Mine" for
level 1 sectors and "LS_Cave" for level 2 and level 3 sectors (see §3.).
Also specify any other static attributes in this list (cf. §2.)
]]
local sectorList = {
-- Miguel's basement
{ location = "A10-1", loadscreen = "LS_Basement", },
-- Tixa
{ location = "J9-1", loadscreen = "LS_Basement", },
-- feeding zone
{ location = "J9-2", loadscreen = "LS_Cave", },
-- Orta
{ location = "K4-1", loadscreen = "LS_Basement", },
-- Meduna
{ location = "O3-1", loadscreen = "LS_Basement", },
{ location = "P3-1", loadscreen = "LS_Basement", },
-- San Mona mine
{ location = "D4-1", },
{ location = "D5-1", },
-- Drassen mine
{ location = "D13-1", },
{ location = "E13-1", },
{ location = "E13-2", },
{ location = "F13-2", },
{ location = "G13-2", },
{ location = "G13-3", },
{ location = "F13-3", },
-- Alma Mine
{ location = "I14-1", },
{ location = "J14-1", },
{ location = "J14-2", },
{ location = "J13-2", },
{ location = "J13-3", },
{ location = "K13-3", },
-- Cambria mine
{ location = "H8-1", },
{ location = "H9-1", },
{ location = "H9-2", },
{ location = "H8-2", },
{ location = "H8-3", },
{ location = "I8-3", },
{ location = "J8-3", },
-- Chitzena mine
{ location = "B2-1", },
-- Grumm mine
{ location = "H3-1", },
{ location = "I3-1", },
{ location = "I3-2", },
{ location = "H3-2", },
{ location = "H4-2", },
{ location = "H4-3", },
{ location = "G4-3", },
-- Demoville
{ location = "P1-1", loadscreen = "LS_Basement", },
{
location = "P1-2", loadscreen = "LS_Cave",
creatureHabitat = Habitat.InnerMine, music = CreatureMusic.Compat,
},
}
-----------------------------
-- INTERESTING STUFF BELOW --
-----------------------------
--[[
PopulateSectors
-- Miguel's basement
addSector( { location = "A10-1" } )
Remarks
This function is supposed to initialize sector settings that depend on
what difficulty level and game style the player chooses.
Parameters
-- Chitzena mine
addSector( { location = "B2-1" } )
difficultyLevel (integer)
Indicates the level of difficulty.
1: easy, 2: experienced, 3: expert, 4: insane
gameStyle (integer)
Indicates whether or not the player selected the scifi option.
0: realistic, 1: scifi
]]
local function PopulateSectors(difficultyLevel, gameStyle)
-- San Mona mine
addSector( { location = "D4-1" } )
addSector( { location = "D5-1" } )
local s = sectorList
----------------------------------------------------------
-- §2. Defining enemy garrisons and creature population --
----------------------------------------------------------
-- Tixa
tixa_1 = { }
tixa_1.location = "J9-1"
tixa_1.numTroops = ({ 8, 11, 15, 20 })[difficultyLevel]
addSector( tixa_1 )
-- feeding zone
tixa_2 = { }
tixa_2.location = "J9-2"
tixa_2.numCreatures = 2 + difficultyLevel*2 + math.random(0, 1)
addSector( tixa_2 )
s["J9-1"].numTroops = ({ 8, 11, 15, 20 })[difficultyLevel]
s["J9-2"].numCreatures = 2 + 2*difficultyLevel + math.random(0, 1)
-- Orta
orta = { }
orta.location = "K4-1"
orta.numTroops = 6 + difficultyLevel*2 + math.random(0, 2)
orta.numElites = 4 + difficultyLevel + math.random(0, 1)
addSector( orta )
s["K4-1"].numTroops = 6 + 2*difficultyLevel + math.random(0, 2)
s["K4-1"].numElites = 4 + difficultyLevel + math.random(0, 1)
-- Meduna
o3 = { location = "O3-1" }
o3.numTroops = 6 + difficultyLevel*2 + math.random(0, 2)
o3.numElites = 4 + difficultyLevel + math.random(0, 1)
addSector( o3 )
p3 = { location = "P3-1" }
if difficultyLevel == 1 then
-- easy
p3.numElites = 8 + math.random(0, 2)
elseif difficultyLevel == 2 then
-- medium
p3.numElites = 10 + math.random(0, 5)
elseif difficultyLevel == 3 then
-- hard
p3.numElites = 14 + math.random(0, 6)
elseif difficultyLevel == 4 then
-- insane
p3.numElites = 20
end
addSector(p3)
-- Drassen mine
addSector( { location = "D13-1" } )
addSector( { location = "E13-1" } )
addSector( { location = "E13-2" } )
addSector( { location = "F13-2" } )
addSector( { location = "G13-2" } )
addSector( { location = "G13-3" } )
addSector( { location = "F13-3" } )
-- Cambria mine
addSector( { location = "H8-1" } )
addSector( { location = "H9-1" } )
addSector( { location = "H9-2" } )
addSector( { location = "H8-2" } )
addSector( { location = "H8-3" } )
addSector( { location = "I8-3" } )
addSector( { location = "J8-3" } )
-- Alma Mine
addSector( { location = "I14-1" } )
addSector( { location = "J14-1" } )
addSector( { location = "J14-2" } )
addSector( { location = "J13-2" } )
addSector( { location = "J13-3" } )
addSector( { location = "K13-3" } )
-- Grumm mine
addSector( { location = "H3-1" } )
addSector( { location = "I3-1" } )
addSector( { location = "I3-2" } )
addSector( { location = "H3-2" } )
addSector( { location = "H4-2" } )
addSector( { location = "H4-3" } )
addSector( { location = "G4-3" } )
s["O3-1"].numTroops = 6 + 2*difficultyLevel + math.random(0, 2)
s["O3-1"].numElites = 4 + difficultyLevel + math.random(0, 1)
s["P3-1"].numElites = ({ 8, 10, 14, 20 })[difficultyLevel]
+ math.random(0, ({ 2, 5, 6, 0 })[difficultyLevel])
-- Demoville
p1_1 = { location = "P1-1" }
p1_1.numTroops = ({ 12, 16, 16, 0 })[difficultyLevel]
p1_1.numElites = ({ 0, 0, 4, 24 })[difficultyLevel]
addSector(p1_1)
s["P1-1"].numTroops = ({ 12, 16, 16, 0 })[difficultyLevel]
s["P1-1"].numElites = ({ 0, 0, 4, 24 })[difficultyLevel]
p1_2 = { location = "P1-2", creatureHabitat = Habitat.InnerMine }
p1_2.numCreatures = ({ 3, 5, 8, 13 })[difficultyLevel]
addSector(p1_2)
s["P1-2"].numCreatures = ({ 3, 5, 8, 13 })[difficultyLevel]
end
---------------------------
-- §3. Internal workings --
---------------------------
--[[
BuildUndergroundSectorList
Remarks
This function gets called by the game when a new game starts. It is
supposed to return the initialized list of underground sectors.
Parameters
gameSettings
Table holding these keys:
- difficultyLevel (integer)
1: easy, 2: experienced, 3: expert, 4: insane
- gameStyle (integer)
0: realistic, 1: scifi
Return value
This function shall return a table of tables that may feature the
following keys:
- location (required)
string of the form "[R][C]-[L]", where [R] is a row
identifier (A-P), [C] is a column identifier (1-16), [L] is a
sublevel identifier (1-3), e.g. "A9-1"
- numAdmins
- numTroops
- numElites
integers, specifying numbers of enemy garrisons, default: 0
- numBloodcats
integer, specifying quantity of bloodcat population, default: 0
This requires bloodcat placements to be set in the map itself.
- numCreatures
integer, specifying number of creatures in total, default: 0
Distribution of creature types depends on creature habitat (see §0.)
- creatureHabitat
integer, specifying creature distribution type
Use one of the constants from the Habitat enumeration (see §0.)
- music
integer, specifying under which circumstances to use creepy music
Use one of the costants from CreatureMusic enumeration (see §0.)
]]
function BuildUndergroundSectorList(gameSettings)
local difficultyLevel = gameSettings["difficultyLevel"]
local gameStyle = gameSettings["gameStyle"]
PopulateSectors(difficultyLevel, gameStyle)
return sectorList
end
--[[
GetLoadscreen
Remarks
Provides the game with the name and file format of the loadscreen for a
given sector. The function forwards the loadscreen attribute as declared
in the sectorList (cf. §1.) or uses default screens.
The game will use the name and format as well as screen resolution to
build the complete file name itself.
Parameters
location (string)
The usual sector location string of the sector the loadscreen is
requested for, e.g. "A10-1".
timeOfDay (integer)
The time in minutes that has passed since midnight.
Return values
This function shall return a 2-tuple of strings, of which the first shall
be the loadscreen name and the second the file extension.
]]
function GetLoadscreen(location, timeOfDay)
local s = sectorList[location]
if s ~= nil and s.loadscreen ~= nil then
return "Loadscreens\\" .. s.loadscreen, "sti"
else
-- resorting to defaults
-- get last character, aka z level
level = location:sub(#location, #location)
if level == "1" then
return "Loadscreens\\LS_Mine", "sti"
else
return "Loadscreens\\LS_Cave", "sti"
end
end
end
------------------------------------
-- §3.1. Underground sector names --
------------------------------------
--[[
Before the game loads this very script it processes another one,
'undergroundsectornames.lua', specifically. For this purpose, it basically
concatenates the two scripts.
'undergroundsectornames.lua' shall define a table of strings, which will
then be referenced in this script to provide the game with sector names.
That specific table shall be called 'sectornames', so make sure to not
overwrite that variable by accident.
]]
--[[
GetSectorName
Remarks
Provides the game with underground sector names.
This function can be called often (i.e. every frame) since currently the
result will not be cached.
Parameters:
sectorCoods
usual coordiantes string, e.g. "A10-1"
sectorDetails
table featuring the following items
- visited (boolean)
Indicates if the player has entered the sector at least once.
- creaturesPresent (boolean)
Indicates whether or not there are any monsters alive.
- detailed (boolean)
Indicates whether the game requests a detailed name.
Return value
This function shall return the requested sector name as a UTF-8 encoded
string.
]]
function GetSectorName(sectorCoords, sectorDetails)
if sectorDetails.visited then
local dash = sectorCoords:find("-")
local coords = sectorCoords:sub(1, dash-1)
if sectornames[sectorCoords] ~= nil then
return coords .. ": " .. sectornames[sectorCoords]
elseif sectornames[sectorCoords:lower()] ~= nil then
-- try lowercase version
return coords .. ": " .. sectornames[sectorCoords:lower()]
else
if sectorDetails.creaturesPresent then
return coords .. ": " .. sectornames.creatureLair
else
return sectorCoords
end
end
else
-- not visited
return ""
end
end
-- For convenient access allow indexing the sectorList by location string.
mt = {}
setmetatable(sectorList, mt)
mt.__index = function(table, key)
for i = 1, #table do
local t = rawget(table, i)
if (t.location == key) then
return t
end
end
return nil
end