def test_expansion_quests_no_endquote_multiline_str(self):
# This file contains an attr val that starts with a quote but ends with only a semicolon.
# In Siege Editor, this is treated as a multi-line string that ends 5 lines further down; the rest of the last line is ignored.
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'quests', 'quests.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(2, len(gas_file.gas.items))
chapters = gas_file.gas.items[0]
self.assertEqual('chapters', chapters.header)
self.assertEqual(5, len(chapters.items))
dsx_chapter_3 = chapters.items[2]
self.assertEqual('dsx_chapter_3', dsx_chapter_3.header)
self.assertEqual(3, len(dsx_chapter_3.items))
sub = dsx_chapter_3.items[2]
self.assertEqual('*', sub.header)
self.assertEqual(2, len(sub.items))
self.assertEqual('description', sub.items[0].name)
messy_description = '"The Shadowjumper\'s trail leads the hero through the ancient sources of the Utraean power. The strongholds of legendary mages Jerkhal and Demlock expose new threats, ' \
'old clues, and everpresent danger.;\n i order = 0;\n }\n [*]\n {\n description = "'
self.assertEqual(messy_description, sub.items[0].value)
self.assertEqual('order', sub.items[1].name)
self.assertEqual(1, sub.items[1].value)
self.assertEqual('i', sub.items[1].datatype)
self.assertEqual(1, len(GasParser.get_instance().clear_warnings()))
def test_multiplayer_quests_1line_multiattr(self):
# This file contains a line that defines multiple attributes
file = os.path.join(self.bits_dir, 'world', 'maps',
'multiplayer_world', 'quests', 'quests.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
quests = gas_file.gas.items[0]
self.assertEqual('quests', quests.header)
self.assertEqual(27, len(quests.items))
quest_flooded_sanctuary = quests.items[-1]
self.assertEqual('quest_flooded_sanctuary',
quest_flooded_sanctuary.header)
self.assertEqual(4, len(quest_flooded_sanctuary.items))
sub = quest_flooded_sanctuary.items[-1]
self.assertEqual('*', sub.header)
self.assertEqual(4, len(sub.items))
self.assertEqual('description', sub.items[2].name)
self.assertEqual(
'"Aid the Sanctuary Keeper by clearing the Flooded Sanctuary of creatures."',
sub.items[2].value)
self.assertEqual('address', sub.items[3].name)
self.assertEqual('of_r1:conversations:conversation_keeper',
sub.items[3].value)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_koe_acr1_spells_1line_headerbrace(self):
# In this file, a section header and its opening brace are on the same line
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_world',
'regions', 'ac_r1', 'spells', 'spells.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
section = gas_file.gas.items[0]
self.assertEqual('n:ac_r1_spells', section.header)
self.assertEqual(0, len(section.items))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_map_world_main_simple(self):
# This is a very simple gas file
map_world_main_file = os.path.join(self.bits_dir, 'world', 'maps',
'map_world', 'main.gas')
gas_file = GasFile(map_world_main_file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
section = gas_file.gas.items[0]
self.assertEqual('t:map,n:map', section.header)
self.assertEqual(11, len(section.items))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_expansion_lore_multiline_comments(self):
# This file contains /* multiline comments */
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'info', 'lore.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
section = gas_file.gas.items[0]
self.assertEqual('lore', section.header)
self.assertEqual(38, len(section.items))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_expres_dsxscorpion_missing_closingbrace(self):
# This file contains a missing closing brace on the first of several templates
# The remaining templates end up as sub-sections
file = os.path.join(self.bits_dir, 'world', 'contentdb', 'templates',
'regular', 'actors', 'evil', 'd',
'dsx_scorpion.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items)) # supposed to be 6
section = gas_file.gas.items[0]
self.assertEqual(17, len(section.items)) # supposed to be 12
self.assertEqual(1, len(GasParser.get_instance().clear_warnings()))
def test_logic_chargeups_skrit(self):
# This file contains multiline inline skrit that starts on the same line
file = os.path.join(self.bits_dir, 'world', 'global', 'effects',
'chargeups.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(42, len(gas_file.gas.items))
section = gas_file.gas.items[0]
self.assertEqual('effect_script*', section.header)
self.assertEqual(2, len(section.items))
self.assertEqual('script', section.items[1].name)
self.assertTrue(section.items[1].value.startswith('[['))
self.assertTrue(section.items[1].value.endswith(']]'))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_logic_lavabeast_rogueattr(self):
# This file contains a rogue attribute between a section header and its opening brace
file = os.path.join(self.bits_dir, 'world', 'contentdb', 'templates',
'regular', 'actors', 'evil', 'd', 'rock_beast.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(6, len(gas_file.gas.items))
lava_beast = gas_file.gas.items[4]
self.assertEqual('t:template,n:lava_beast', lava_beast.header)
self.assertEqual(10, len(lava_beast.items))
physics = lava_beast.items[8]
self.assertEqual('physics', physics.header)
self.assertEqual(1, len(physics.items))
self.assertEqual(1, len(GasParser.get_instance().clear_warnings()))
def test_expres_dsxskeleton_additional_closingbrace(self):
# This file contains an additional closing brace in the middle of a template section
# The remaining sections end up on top-level
file = os.path.join(self.bits_dir, 'world', 'contentdb', 'templates',
'regular', 'actors', 'evil', 'c',
'dsx_skeleton.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(9, len(gas_file.gas.items)) # supposed to be 8
dsx_skeleton_04 = gas_file.gas.items[1]
self.assertEqual('t:template,n:dsx_skeleton_04',
dsx_skeleton_04.header)
self.assertEqual(11, len(dsx_skeleton_04.items)) # supposed to be 12
self.assertEqual(1, len(GasParser.get_instance().clear_warnings()))
def test_map_expansion_main_datatypes(self):
# This gas file has attributes with datatypes
map_expansion_main_file = os.path.join(self.bits_dir, 'world', 'maps',
'map_expansion', 'main.gas')
gas_file = GasFile(map_expansion_main_file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
section = gas_file.gas.items[0]
self.assertEqual('t:map,n:map', section.header)
self.assertEqual(12, len(section.items))
dev_only = section.items[1]
self.assertEqual('dev_only', dev_only.name)
self.assertEqual('b', dev_only.datatype)
self.assertEqual(False, dev_only.value)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_expres_dsxcontainers_1line_roguechar_brace(self):
# This file contains a rogue character and a section's opening brace on the same line
file = os.path.join(self.bits_dir, 'world', 'contentdb', 'templates',
'regular', 'interactive', 'containers',
'dsx_containers.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(266, len(gas_file.gas.items))
crate_inventory = gas_file.gas.get_section(
't:template,n:crate_dsx_a6_r3-02').get_section('inventory')
self.assertEqual(2, len(crate_inventory.items))
pcontent = crate_inventory.items[1]
self.assertEqual('pcontent', pcontent.header)
self.assertEqual(1, len(pcontent.items))
self.assertEqual('oneof*', pcontent.items[0].header)
self.assertEqual(1, len(GasParser.get_instance().clear_warnings()))
def load(cls, gas_file: GasFile) -> DecalsGas:
decals_section = gas_file.get_gas().get_section('decals')
decals = [
Decal.from_gas(decal_section)
for decal_section in decals_section.get_sections('t:decal,n:*')
]
return DecalsGas(decals)
def test_koe_dfbandits_nonint_material_garbage(self):
# This file contains some serious garbage in the value of a completely unimportant attribute. Should not crash.
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_world',
'regions', 'df_bandits', 'objects',
'non_interactive.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(2276, len(gas_file.gas.items))
broken_foliage = list(
filter(
lambda x: x.items[0].header == 'aspect' and x.items[0].items[0]
.name == 'material', gas_file.gas.items))
self.assertEqual(1, len(broken_foliage))
broken_foliage = broken_foliage[0]
self.assertEqual(2, len(broken_foliage.items))
self.assertEqual(1, len(broken_foliage.items[0].items))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_logic_loadsave_1linesquarebrace_semicolon(self):
# This file contains single-line [[squarebrace delimited text;]] that contains a semicolon
file = os.path.join(self.bits_dir, 'ui', 'interfaces', 'backend',
'loadsave_game', 'loadsave_game.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
loadsave_game = gas_file.gas.items[0]
self.assertEqual('loadsave_game', loadsave_game.header)
self.assertEqual(18, len(loadsave_game.items))
edit_box = loadsave_game.items[10]
self.assertEqual('t:edit_box,n:loadsave_game_name_edit_box',
edit_box.header)
self.assertEqual(20, len(edit_box.items))
excluded_chars = edit_box.items[14]
self.assertEqual('excluded_chars', excluded_chars.name)
self.assertEqual(r'[["<>:/\|?*.%;]]', excluded_chars.value)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_expansion_victory_missing_semicolon(self):
# This file is missing a semicolon after an attribute
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'info', 'victory.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
victory = gas_file.gas.items[0]
self.assertEqual('victory', victory.header)
self.assertEqual(2, len(victory.items))
condition = victory.items[1]
self.assertEqual('condition*', condition.header)
self.assertEqual(4, len(condition.items))
self.assertEqual('dsx_end_game',
condition.items[0].value) # semicolon should be cut
self.assertEqual('"get staff of stars"', condition.items[1].value
) # missing semicolon, value should not be cut
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_logic_components_multiline_skrit(self):
# This file contains inline skrit as an attribute value
file = os.path.join(self.bits_dir, 'world', 'contentdb', 'components',
'components.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(23, len(gas_file.gas.items))
physics = gas_file.gas.items[19]
self.assertEqual('t:component,n:physics', physics.header)
self.assertEqual(37, len(physics.items))
physics_effect = physics.items[-1]
self.assertEqual('t:constraint,n:physics_effect',
physics_effect.header)
self.assertEqual(1, len(physics_effect.items))
self.assertEqual('skrit', physics_effect.items[0].name)
skrit = physics_effect.items[0].value.strip()
self.assertTrue(skrit.startswith('[['))
self.assertTrue(skrit.endswith(']]'))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_exp_a9r1mesa_conv_1line_braceattr(self):
# In this file, an opening brace and an attribute are on the same line
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'regions', 'a9_r1_mesa', 'conversations',
'conversations.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(3, len(gas_file.gas.items))
therg_hello = gas_file.gas.items[0]
self.assertEqual('therg_hello', therg_hello.header)
self.assertEqual(4, len(therg_hello.items))
sub3 = therg_hello.items[2]
self.assertEqual('text*', sub3.header)
self.assertEqual(6, len(sub3.items))
self.assertEqual('i', sub3.items[0].datatype)
self.assertEqual('order', sub3.items[0].name)
self.assertEqual(2, sub3.items[0].value)
self.assertEqual('sample', sub3.items[1].name)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_expansion_overheadmap_singlechar_attrnames(self):
# This file contains single-character attribute names - not to be confused with datatypes
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'info', 'overheadmap.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
overheadmap = gas_file.gas.items[0]
self.assertEqual('overheadmap', overheadmap.header)
self.assertEqual(3, len(overheadmap.items))
pieces = overheadmap.items[1]
self.assertEqual('pieces', pieces.header)
self.assertEqual(24, len(pieces.items))
arhok = pieces.items[0]
self.assertEqual('arhok', arhok.header)
self.assertEqual(4, len(arhok.items))
x = arhok.items[2]
self.assertEqual('x', x.name)
self.assertIsNone(x.datatype)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_logic_components_1line_section(self):
# This file contains whole sections on a single line
file = os.path.join(self.bits_dir, 'world', 'contentdb', 'components',
'components.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(23, len(gas_file.gas.items))
actor = gas_file.gas.items[0]
self.assertEqual('t:component,n:actor', actor.header)
self.assertEqual(24, len(actor.items))
can_level_up = actor.items[6]
self.assertEqual('can_level_up', can_level_up.header)
self.assertEqual(3, len(can_level_up.items))
self.assertEqual('type', can_level_up.items[0].name)
self.assertEqual('bool', can_level_up.items[0].value)
self.assertEqual('default', can_level_up.items[1].name)
self.assertEqual('false', can_level_up.items[1].value)
self.assertEqual('doc', can_level_up.items[2].name)
self.assertEqual('"Can this object \'level up\'?"',
can_level_up.items[2].value)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_loa_a3r3aaglet_multiline_skritqueryparams(self):
# This file contains multi-line values that are skrit file names followed by URL-like query params
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'regions', 'a3_r3a_aglet', 'objects', 'regular',
'actor.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(82, len(gas_file.gas.items))
automaton = gas_file.gas.items[23]
self.assertEqual('t:dsx_automaton_weathered,n:0x24a00405',
automaton.header)
self.assertEqual(3, len(automaton.items))
mind = automaton.items[1]
self.assertEqual('mind', mind.header)
self.assertEqual(11, len(mind.items))
jat_brain = mind.items[3]
self.assertEqual('jat_brain', jat_brain.name)
self.assertEqual(
'world\\ai\\jobs\\common\\brain_hero.skrit\n ?actor_joins_existing_party=false\n &actor_creates_own_party=false',
jat_brain.value)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def load_plant_profile_gas(gas_file_path):
plant_distributions = []
gas_file = GasFile(gas_file_path)
gas = gas_file.get_gas()
ppp_section = gas.get_section('perlin_plant_profile')
seed_default = ppp_section.get_attr_value('seed')
templates_default = ppp_section.get_attr_value('templates')
size_default = ppp_section.get_attr_value('size')
for distro_section in ppp_section.get_sections('*'):
seed = distro_section.get_attr_value('seed') or seed_default
templates = distro_section.get_attr_value(
'templates') or templates_default
size = distro_section.get_attr_value('size') or size_default
seed_factor, perlin_offset, perlin_spread = [
float(x) for x in seed.split(',')
]
plant_templates = templates.split()
size = [float(s) for s in size.split()] if size else None
distro = PerlinPlantDistribution(perlin_offset, perlin_spread,
seed_factor, plant_templates, size)
plant_distributions.append(distro)
return PerlinPlantProfile(plant_distributions)
def test_expansion_lore_semicolon_in_quotes(self):
# This file contains "a semicolon; inside a quoted string"
file = os.path.join(self.bits_dir, 'world', 'maps', 'map_expansion',
'info', 'lore.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
section = gas_file.gas.items[0]
self.assertEqual('lore', section.header)
self.assertEqual(38, len(section.items))
lore_2arhok = section.items[7]
self.assertEqual('lore_2arhok', lore_2arhok.header)
description = repr(
"Another part of your Mother's journal.\n\n'... The land is quite amazing. The flora here is like nothing in Arhok, which spends a great deal of time buried in the harsh "
"winter snow. Here great plants and trees tower above us ...'\n\n '... The creatures attacked us on the beach, leaving poor K'thon lifeless on the sand. I tried to rescue "
"him while he still lived; I dropped my shield and pack so I could drag him across the sand, but he was dead before I lost sight of the sea, and there was no way to return "
"through the lizard armies to retrieve my equipment ...'\n\n'For now the shield will have to be a marker for K'thon's spirit; I will try to find it again when we return to "
"Arhok ...'\n\n'Our Utraean friends have given a name to our foe: the Zaurask. These lizard beasts are fierce fighters and attack in well-organized packs. We have been "
"told that they are led by a great king whose name is Nosirrom and that this beast has but one goal - to make the Utraeans' Fortress Emarard its home. It has ambition, "
"I'll give it that, but we have taken up the cause of these strange wizard folk, and we will not let the Zaurask overwhelm them ...'"
)
self.assertEqual(description, lore_2arhok.items[0].value)
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def test_siegeeditorextras_effectschema_escaped_quotes(self):
# This file contains "text with \"escaped\" quotes" (which aren't a thing) and missing end quotes and is a complete mess.
# Just documenting current parser behavior. Parser behaves the same way as SE, which uses the file.
file = os.path.join(self.bits_dir, 'config', 'editor',
'effect_schema.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
effect_schema = gas_file.gas.items[0]
self.assertEqual('effect_schema', effect_schema.header)
self.assertEqual(3, len(effect_schema.items))
effect_parameters = effect_schema.items[2]
self.assertEqual('effect_parameters', effect_parameters.header)
self.assertEqual(6, len(effect_parameters.items)) # supposed to be: 23
splat = effect_parameters.find_sections_recursive('splat')
self.assertEqual(1, len(splat))
splat = splat[0]
self.assertEqual(1, len(splat.items))
self.assertEqual('doc', splat.items[0].name)
self.assertEqual(
r'"Causes particles to \"', splat.items[0].value
) # supposed to be: "Causes particles to \"splat\" onto terrain polygon"
self.assertEqual(4, len(GasParser.get_instance().clear_warnings()))
def test_logic_console_multiline_string(self):
# This file contains multiline string values that do not start on the same line
file = os.path.join(self.bits_dir, 'config', 'console.gas')
gas_file = GasFile(file)
gas_file.load()
self.assertEqual(1, len(gas_file.gas.items))
console = gas_file.gas.items[0]
self.assertEqual('console', console.header)
self.assertEqual(1, len(console.items))
exec_section = console.items[0]
self.assertEqual('exec', exec_section.header)
self.assertEqual(6, len(exec_section.items))
e3 = exec_section.items[3]
self.assertEqual('e3', e3.header)
self.assertEqual(8, len(e3.items))
hero_cr = e3.items[0]
self.assertEqual('hero_cr', hero_cr.header)
self.assertEqual(2, len(hero_cr.items))
command = hero_cr.items[0]
self.assertEqual('command', command.name)
self.assertEqual(242, len(command.value))
self.assertTrue(command.value.startswith('"'))
self.assertTrue(command.value.endswith('"'))
self.assertEqual(0, len(GasParser.get_instance().clear_warnings()))
def load(cls, gas_file: GasFile):
gas = gas_file.get_gas()
shd_section = gas.get_section('stitch_helper_data')
srg = shd_section.get_attr_value('source_region_guid')
srn = shd_section.get_attr_value('source_region_name')
ses = list()
stitch_editor_sections = shd_section.get_sections()
for se_section in stitch_editor_sections:
dest_region = se_section.get_attr_value('dest_region')
assert se_section.header == f't:stitch_editor,n:{dest_region}'
node_ids = dict()
node_id_attrs = se_section.get_section('node_ids').get_attrs()
for ni_attr in node_id_attrs:
stitch_id = ni_attr.name
node_guid, door = ni_attr.value.split(',')
node_ids[stitch_id] = (node_guid, door)
se = StitchEditor(dest_region, node_ids)
ses.append(se)
stitch_helper_gas = StitchHelperGas(srg, srn, ses)
return stitch_helper_gas
def load(cls, gas_file: GasFile):
gas = gas_file.get_gas()
siege_node_list = gas.get_section('t:terrain_nodes,n:siege_node_list')
nodes_gas = NodesGas()
# attributes
nodes_gas.ambient_color = siege_node_list.get_attr_value('ambient_color')
nodes_gas.ambient_intensity = siege_node_list.get_attr_value('ambient_intensity')
nodes_gas.object_ambient_color = siege_node_list.get_attr_value('object_ambient_color')
nodes_gas.object_ambient_intensity = siege_node_list.get_attr_value('object_ambient_intensity')
nodes_gas.actor_ambient_color = siege_node_list.get_attr_value('actor_ambient_color')
nodes_gas.actor_ambient_intensity = siege_node_list.get_attr_value('actor_ambient_intensity')
nodes_gas.targetnode = siege_node_list.get_attr_value('targetnode')
node_sections = siege_node_list.get_sections()
nodes = list()
for node_section in node_sections:
guid = node_section.get_attr_value('guid')
mesh_guid = node_section.get_attr_value('mesh_guid')
texsetabbr = node_section.get_attr_value('texsetabbr')
bounds_camera = node_section.get_attr_value('bounds_camera')
camera_fade = node_section.get_attr_value('camera_fade')
occludes_camera = node_section.get_attr_value('occludes_camera')
occludes_light = node_section.get_attr_value('occludes_light')
nodesection = node_section.get_attr_value('nodesection')
nodelevel = node_section.get_attr_value('nodelevel')
nodeobject = node_section.get_attr_value('nodeobject')
snode = SNode(guid, mesh_guid, texsetabbr, bounds_camera, camera_fade, occludes_camera, occludes_light, nodesection, nodelevel, nodeobject)
nodes.append(snode)
snode.doors = list()
door_sections = node_section.get_sections('door*')
for door_section in door_sections:
id = door_section.get_attr_value('id')
farguid = door_section.get_attr_value('farguid')
fardoor = door_section.get_attr_value('fardoor')
snode.doors.append(Door(id, farguid, fardoor))
nodes_gas.nodes = nodes
return nodes_gas
def load(cls, name: str) -> Progression:
for base_path in [os.path.join(Bits.DSLOA_PATH, 'gaspy'), 'input']:
file_path = os.path.join(base_path, f'{name}.progression.gas')
if os.path.isfile(file_path):
return cls.load_gas(GasFile(file_path).get_gas())
