def test_multi_create_pickup_data_for_other(pickup_for_create_pickup_data):
# Setup
multi = ItemResourceInfo("Multiworld", "Multiworld", 30, None)
solo = pickup_exporter.PickupExporterSolo(pickup_exporter.GenericAcquiredMemo())
creator = pickup_exporter.PickupExporterMulti(solo, multi, PlayersConfiguration(0, {0: "You", 1: "Someone"}))
model = MagicMock()
resource_a = ItemResourceInfo("A", "A", 10, None)
resource_b = ItemResourceInfo("B", "B", 10, None)
# Run
data = creator.create_details(PickupIndex(10), PickupTarget(pickup_for_create_pickup_data, 1),
pickup_for_create_pickup_data, PickupModelStyle.ALL_VISIBLE,
"Scan Text", model)
# Assert
assert data == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(10),
scan_text="Someone's Scan Text",
hud_text=['Sent Cake to Someone!'],
conditional_resources=[
ConditionalResources(None, None, ((multi, 11),)),
],
conversion=[],
model=model,
other_player=True,
original_pickup=pickup_for_create_pickup_data,
)
def test_pickup_data_for_pb_expansion_unlocked(echoes_item_database, echoes_resource_database):
# Setup
pickup = pickup_creator.create_ammo_expansion(
echoes_item_database.ammo["Power Bomb Expansion"],
[2],
False,
echoes_resource_database,
)
creator = pickup_exporter.PickupExporterSolo(patch_data_factory._simplified_memo_data())
# Run
details = creator.export(PickupIndex(0), PickupTarget(pickup, 0), pickup, PickupModelStyle.ALL_VISIBLE)
result = patch_data_factory.echoes_pickup_details_to_patcher(details, MagicMock())
# Assert
assert result == {
"pickup_index": 0,
"scan": "Power Bomb Expansion. Provides 2 Power Bombs and 1 Item Percentage",
"model": {"game": "prime2", "name": "PowerBombExpansion"},
"hud_text": ["Power Bomb Expansion acquired!"],
'resources': [{'amount': 2, 'index': 43},
{'amount': 1, 'index': 47}],
"conditional_resources": [],
"convert": [],
}
def test_multi_create_pickup_data_for_self(pickup_for_create_pickup_data):
# Setup
solo = pickup_exporter.PickupExporterSolo(pickup_exporter.GenericAcquiredMemo())
creator = pickup_exporter.PickupExporterMulti(solo, MagicMock(), PlayersConfiguration(0, {0: "You", 1: "Someone"}))
model = MagicMock()
resource_a = ItemResourceInfo(0, "A", "A", 10)
resource_b = ItemResourceInfo(1, "B", "B", 10)
# Run
data = creator.create_details(PickupIndex(10), PickupTarget(pickup_for_create_pickup_data, 0),
pickup_for_create_pickup_data, PickupModelStyle.ALL_VISIBLE,
"Scan Text", model)
# Assert
assert data == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(10),
scan_text="Your Scan Text",
hud_text=['A acquired!', 'B acquired!'],
conditional_resources=[
ConditionalResources("A", None, ((resource_a, 1),)),
ConditionalResources("B", resource_a, ((resource_b, 1),)),
],
conversion=[],
model=model,
other_player=False,
original_pickup=pickup_for_create_pickup_data,
)
def test_create_pickup_all_from_pool(echoes_resource_database,
default_echoes_configuration,
disable_hud_popup: bool
):
item_pool = pool_creator.calculate_pool_results(default_echoes_configuration,
echoes_resource_database)
index = PickupIndex(0)
if disable_hud_popup:
memo_data = patch_data_factory._simplified_memo_data()
else:
memo_data = default_prime2_memo_data()
creator = pickup_exporter.PickupExporterSolo(memo_data)
for item in item_pool.pickups:
data = creator.export(index, PickupTarget(item, 0), item, PickupModelStyle.ALL_VISIBLE)
for hud_text in data.hud_text:
assert not hud_text.startswith("Locked")
def test_pickup_data_for_pb_expansion_locked(simplified, echoes_item_database, echoes_resource_database):
# Setup
pickup = pickup_creator.create_ammo_expansion(
echoes_item_database.ammo["Power Bomb Expansion"],
[2],
True,
echoes_resource_database,
)
if simplified:
memo = patch_data_factory._simplified_memo_data()
hud_text = [
"Power Bomb Expansion acquired, but the main Power Bomb is required to use it.",
"Power Bomb Expansion acquired!",
]
else:
memo = default_database.default_prime2_memo_data()
hud_text = [
"Power Bomb Expansion acquired! \n"
"Without the main Power Bomb item, you are still unable to release Power Bombs.",
"Power Bomb Expansion acquired! \nMaximum Power Bomb carrying capacity increased by 2.",
]
creator = pickup_exporter.PickupExporterSolo(memo)
# Run
details = creator.export(PickupIndex(0), PickupTarget(pickup, 0), pickup, PickupModelStyle.ALL_VISIBLE)
result = patch_data_factory.echoes_pickup_details_to_patcher(details, MagicMock())
# Assert
assert result == {
"pickup_index": 0,
"scan": "Power Bomb Expansion. Provides 2 Power Bombs and 1 Item Percentage",
"model": {"game": "prime2", "name": "PowerBombExpansion"},
"hud_text": hud_text,
'resources': [{'amount': 2, 'index': 72},
{'amount': 1, 'index': 47}],
"conditional_resources": [
{'item': 43,
'resources': [{'amount': 2, 'index': 43},
{'amount': 1, 'index': 47}]}
],
"convert": [],
}
def test_pickup_data_for_seeker_launcher(echoes_item_database, echoes_resource_database):
# Setup
state = MajorItemState(
include_copy_in_original_location=False,
num_shuffled_pickups=0,
num_included_in_starting_items=0,
included_ammo=(5,),
)
pickup = pickup_creator.create_major_item(
echoes_item_database.major_items["Seeker Launcher"],
state,
True,
echoes_resource_database,
echoes_item_database.ammo["Missile Expansion"],
True
)
creator = pickup_exporter.PickupExporterSolo(patch_data_factory._simplified_memo_data())
# Run
details = creator.export(PickupIndex(0), PickupTarget(pickup, 0), pickup, PickupModelStyle.ALL_VISIBLE)
result = patch_data_factory.echoes_pickup_details_to_patcher(details, MagicMock())
# Assert
assert result == {
"pickup_index": 0,
"scan": "Seeker Launcher",
"model": {"game": "prime2", "name": "SeekerLauncher"},
"hud_text": ["Seeker Launcher acquired, but the Missile Launcher is required to use it.",
"Seeker Launcher acquired!"],
'resources': [{'amount': 5, 'index': 71},
{'amount': 1, 'index': 47},
{'amount': 1, 'index': 26}],
"conditional_resources": [
{'item': 73,
'resources': [{'amount': 5, 'index': 44},
{'amount': 1, 'index': 47},
{'amount': 1, 'index': 26}]}
],
"convert": [],
}
def test_create_pickup_list(model_style: PickupModelStyle, empty_patches, generic_item_category,
blank_resource_db):
# Setup
has_scan_text = model_style in {PickupModelStyle.ALL_VISIBLE, PickupModelStyle.HIDE_MODEL}
rng = Random(5000)
model_0 = MagicMock(spec=PickupModel)
model_1 = MagicMock(spec=PickupModel)
model_2 = MagicMock(spec=PickupModel)
useless_model = PickupModel(
game=RandovaniaGame.METROID_PRIME_ECHOES,
name="EnergyTransferModule",
)
useless_resource = ItemResourceInfo(0, "Useless", "Useless", 10)
resource_a = ItemResourceInfo(1, "A", "A", 10)
resource_b = ItemResourceInfo(2, "B", "B", 10)
pickup_a = PickupEntry("P-A", model_1, generic_item_category, generic_item_category,
progression=((resource_a, 1),),
)
pickup_b = PickupEntry("P-B", model_2, generic_item_category, generic_item_category,
progression=((resource_b, 1),
(resource_a, 5)), )
pickup_c = PickupEntry("P-C", model_2, AMMO_ITEM_CATEGORY, generic_item_category,
progression=tuple(),
extra_resources=((resource_b, 2), (resource_a, 1)),
unlocks_resource=True,
resource_lock=ResourceLock(resource_a, resource_a, useless_resource))
useless_pickup = PickupEntry("P-Useless", model_0, USELESS_ITEM_CATEGORY, USELESS_ITEM_CATEGORY,
progression=((useless_resource, 1),))
patches = empty_patches.assign_new_pickups([
(PickupIndex(0), PickupTarget(pickup_a, 0)),
(PickupIndex(2), PickupTarget(pickup_b, 0)),
(PickupIndex(3), PickupTarget(pickup_a, 0)),
(PickupIndex(4), PickupTarget(pickup_c, 0)),
])
creator = pickup_exporter.PickupExporterSolo(pickup_exporter.GenericAcquiredMemo())
world_list = MagicMock()
world_list.iterate_nodes.return_value = [
PickupNode(NodeIdentifier.create("World", "Area", f"Name {i}"),
i, False, None, "", ("default",), {}, PickupIndex(i), False)
for i in range(5)
]
# Run
result = pickup_exporter.export_all_indices(
patches,
PickupTarget(useless_pickup, 0),
world_list,
rng,
model_style,
PickupModelDataSource.ETM,
creator,
pickup_creator.create_visual_etm(),
)
# Assert
assert len(result) == 5
assert result[0] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(0),
scan_text="P-A" if has_scan_text else "Unknown item",
hud_text=["A acquired!"] if model_style != PickupModelStyle.HIDE_ALL else ['Unknown item acquired!'],
conditional_resources=[ConditionalResources("A", None, ((resource_a, 1),))],
conversion=[],
model=model_1 if model_style == PickupModelStyle.ALL_VISIBLE else useless_model,
other_player=False,
original_pickup=pickup_a,
)
assert result[1] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(1),
scan_text="P-Useless" if has_scan_text else "Unknown item",
hud_text=["Useless acquired!"] if model_style != PickupModelStyle.HIDE_ALL else ['Unknown item acquired!'],
conditional_resources=[ConditionalResources("Useless", None, ((useless_resource, 1),))],
conversion=[],
model=model_0 if model_style == PickupModelStyle.ALL_VISIBLE else useless_model,
other_player=False,
original_pickup=useless_pickup,
)
assert result[2] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(2),
scan_text="P-B. Provides the following in order: B, A" if has_scan_text else "Unknown item",
hud_text=["B acquired!", "A acquired!"] if model_style != PickupModelStyle.HIDE_ALL else [
'Unknown item acquired!', 'Unknown item acquired!'],
conditional_resources=[
ConditionalResources("B", None, ((resource_b, 1),)),
ConditionalResources("A", resource_b, ((resource_a, 5),)),
],
conversion=[],
model=model_2 if model_style == PickupModelStyle.ALL_VISIBLE else useless_model,
other_player=False,
original_pickup=pickup_b,
)
assert result[3] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(3),
scan_text="P-A" if has_scan_text else "Unknown item",
hud_text=["A acquired!"] if model_style != PickupModelStyle.HIDE_ALL else ['Unknown item acquired!'],
conditional_resources=[ConditionalResources("A", None, ((resource_a, 1),))],
conversion=[],
model=model_1 if model_style == PickupModelStyle.ALL_VISIBLE else useless_model,
other_player=False,
original_pickup=pickup_a,
)
assert result[4] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(4),
scan_text="P-C. Provides 2 B and 1 A" if has_scan_text else "Unknown item",
hud_text=["P-C acquired!"] if model_style != PickupModelStyle.HIDE_ALL else ['Unknown item acquired!'],
conditional_resources=[ConditionalResources("P-C", None, (
(resource_b, 2), (resource_a, 1),
))],
conversion=[ResourceConversion(source=useless_resource, target=resource_a)],
model=model_2 if model_style == PickupModelStyle.ALL_VISIBLE else useless_model,
other_player=False,
original_pickup=pickup_c,
)
def test_create_pickup_list_random_data_source(has_memo_data: bool, empty_patches, generic_item_category):
# Setup
rng = Random(5000)
resource_b = ItemResourceInfo(0, "B", "B", 10)
model_1 = MagicMock(spec=PickupModel)
model_2 = MagicMock(spec=PickupModel)
useless_model = PickupModel(game=RandovaniaGame.METROID_PRIME_CORRUPTION, name="Useless")
pickup_a = PickupEntry("A", model_1, generic_item_category, generic_item_category,
progression=tuple())
pickup_b = PickupEntry("B", model_2, generic_item_category, generic_item_category,
progression=((resource_b, 1), (resource_b, 1)))
pickup_c = PickupEntry("C", model_2, generic_item_category, generic_item_category,
progression=tuple())
useless_pickup = PickupEntry("Useless", useless_model, USELESS_ITEM_CATEGORY, USELESS_ITEM_CATEGORY,
progression=tuple())
patches = empty_patches.assign_new_pickups([
(PickupIndex(0), PickupTarget(pickup_a, 0)),
(PickupIndex(2), PickupTarget(pickup_b, 0)),
(PickupIndex(3), PickupTarget(pickup_a, 0)),
(PickupIndex(4), PickupTarget(pickup_c, 0)),
])
if has_memo_data:
memo_data = {
"A": "This is an awesome item A",
"B": "This is B. It is good.",
"C": "What a nice day to have a C",
"Useless": "Try again next time",
}
else:
memo_data = {
name: "{} acquired!".format(name)
for name in ("A", "B", "C", "Useless")
}
creator = pickup_exporter.PickupExporterSolo(memo_data)
world_list = MagicMock()
world_list.iterate_nodes.return_value = [
PickupNode(NodeIdentifier.create("W", "A", f"Name {i}"),
i, False, None, "", ("default",), {}, PickupIndex(i), False)
for i in range(5)
]
# Run
result = pickup_exporter.export_all_indices(
patches,
PickupTarget(useless_pickup, 0),
world_list,
rng,
PickupModelStyle.HIDE_ALL,
PickupModelDataSource.RANDOM,
creator,
pickup_creator.create_visual_etm(),
)
# Assert
assert len(result) == 5
assert result[0] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(0),
scan_text="A",
hud_text=[memo_data["A"]],
conditional_resources=[ConditionalResources("A", None, ())],
conversion=[],
model=model_1,
other_player=False,
original_pickup=pickup_a,
)
assert result[1] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(1),
scan_text="A",
hud_text=[memo_data["A"]],
conditional_resources=[ConditionalResources("Useless", None, ())],
conversion=[],
model=model_1,
other_player=False,
original_pickup=useless_pickup,
)
assert result[2] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(2),
scan_text="C",
hud_text=[memo_data["C"], memo_data["C"]],
conditional_resources=[
ConditionalResources("B", None, ((resource_b, 1),)),
ConditionalResources("B", resource_b, ((resource_b, 1),)),
],
conversion=[],
model=model_2,
other_player=False,
original_pickup=pickup_b,
)
assert result[3] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(3),
scan_text="B",
hud_text=[memo_data["B"]],
conditional_resources=[ConditionalResources("A", None, ())],
conversion=[],
model=model_2,
other_player=False,
original_pickup=pickup_a,
)
assert result[4] == pickup_exporter.ExportedPickupDetails(
index=PickupIndex(4),
scan_text="A",
hud_text=[memo_data["A"]],
conditional_resources=[ConditionalResources("C", None, ())],
conversion=[],
model=model_1,
other_player=False,
original_pickup=pickup_c,
)