2.0.0 Test PR

.gitignore

@@ -6,7 +6,7 @@ EA/*
 !EA/README.md
 
 # Libraries
-Libraries/*/
+Libraries/S4CL/*
 
 # Additional non mod related items
 Scripts/rel
@@ -55,3 +55,4 @@ settings.py
 Pipfile
 .DS_Store
 # Project exclude paths
+/Libraries/core-library/lot51_core/*

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "Libraries/core-library"]
+	path = Libraries/core-library/lot51_core
+	url = https://github.com/lot51/core-library.git
+[submodule "Package/src"]
+	path = Package/src
+	url = https://github.com/Simsipelago/Sims4ArchipelagoPackage.git
+[submodule "Libraries/lot51_core"]
+	path = Libraries/lot51_core
+	url = https://github.com/lot51/core-library.git

Scripts/s4ap/enums/S4APLocalization.py

@@ -1,9 +1,6 @@
-from sims4communitylib.enums.icons_enum import CommonIconId
-from sims4communitylib.enums.strings_enum import CommonStringId
-from sims4communitylib.enums.traits_enum import CommonTraitId
+from enum import Int
 
-
-class S4APTraitId(CommonTraitId):
+class S4APTraitId(Int):
     LOCK_MIXOLOGY_SKILL: 'S4APTraitId' = 3494693146
     LOCK_MISCHIEF_SKILL: 'S4APTraitId' = 3494693147
     LOCK_HANDINESS_SKILL: 'S4APTraitId' = 3494693148
@@ -31,7 +28,7 @@ class S4APTraitId(CommonTraitId):
     SHOW_RECEIVED_SKILLS: 'S4APTraitId' = 3511470836
     RESYNC_LOCATIONS: 'S4APTraitId' = 2224316686
     SHOW_YAML_OPTIONS: 'S4APTraitId' = 2241086516
-class S4APStringId(CommonStringId):
+class S4APStringId(Int):
     # ap_client
     CONNECTION_REFUSED: 'S4APStringId' = 0x964EABE6
     CONNECTION_ERROR: 'S4APStringId' = 0xC50BC4AF
@@ -55,7 +52,7 @@ class S4APStringId(CommonStringId):
     CONFLICTING_CONNECTION_DATA_DESC: 'S4APStringId' = 0x3E4E79D3
 
 
-class S4APIconId(CommonIconId):
+class S4APIconId(Int):
     AP_LOGO_BLUE: 'S4APIconId' = 0xBD85B76B1017163F
 
 class S4APBaseGameSkills:
@@ -242,7 +239,7 @@ def __init__(self):
             2252361604: 'Competent Wordsmith (Bestselling Author 2)',
             1903266201: 'Novelest Novelist (Bestselling Author 3)',
             2893015914: 'Bestselling Author (Bestselling Author 4)',
-            669436583: 'Tone Deaf (Musical Genius 1)',
+            669436583: 'Tone-Deaf (Musical Genius 1)',
             527786058: 'Fine Tuned (Musical Genius 2)',
             3847573573: 'Harmonious (Musical Genius 3)',
             3320148467: 'Musical Genius (Musical Genius 4)',
@@ -276,11 +273,11 @@ def __init__(self):
             3410479215: 'The Great Landscaper (Mansion Baron 2)',
             1430851502: 'Home Renovator (Mansion Baron 3)',
             3008497549: 'Mansion Baron (Mansion Baron 4)',
-            1603920936: 'Prudent Student (Renaissance Sim / Nerd Brain 1',
+            1603920936: 'Prudent Student (Renaissance Sim / Nerd Brain 1)',
             3576085519: 'Jack of Some Trades (Renaissance Sim 2)',
             3843569882: 'Pantologist (Renaissance Sim 3)',
             517310505: 'Renaissance Sim (Renaissance Sim 4)',
-            2769839652: 'With The Program (Computer Whiz 1)',
+            2769839652: 'With the Program (Computer Whiz 1)',
             1394699556: 'Technically Adept (Computer Whiz 2)',
             1896269241: 'Computer Geek (Computer Whiz 3)',
             2969693962: 'Computer Whiz (Computer Whiz 4)',
@@ -311,7 +308,7 @@ def __init__(self):
             2167317685: 'Funny (Joke Star 3)',
             2867786966: 'Joke Star (Joke Star 4)',
             2179132818: 'New in Town (Party Animal / Friend of the World 1)',
-            6359719: 'Well liked (Friend of the World 2)',
+            6359719: 'Well Liked (Friend of the World 2)',
             3307311430: 'Super Friend (Friend of the World 3)',
             3184496709: 'Friend of the World (Friend of the World 4)',
             1596456398: 'Welcoming Host (Party Animal 2)',

Scripts/s4ap/events/aspiration_event_dispatcher.py

@@ -3,11 +3,11 @@
 from s4ap.enums.S4APLocalization import HashLookup
 from s4ap.events.checks.send_check_event import SendLocationEvent
 from s4ap.modinfo import ModInfo
+from s4ap.utils.s4ap_sim_utils import S4APSimUtils
 from sims4communitylib.events.event_handling.common_event import CommonEvent
 from sims4communitylib.events.event_handling.common_event_registry import CommonEventRegistry
 from sims4communitylib.services.common_service import CommonService
-from sims4communitylib.utils.common_injection_utils import CommonInjectionUtils
-from sims4communitylib.utils.sims.common_sim_utils import CommonSimUtils
+from lot51_core.utils.injection import inject_to
 
 
 class MilestoneCompletion(CommonEvent):
@@ -29,9 +29,7 @@ def milestone_display_name(self):
     def milestone_count(self):
         return self._milestone_count
 
-
-@CommonInjectionUtils.inject_safely_into(ModInfo.get_identity(), AspirationTracker,
-                                         AspirationTracker.complete_milestone.__name__, handle_exceptions=True)
+@inject_to(AspirationTracker, AspirationTracker.complete_milestone.__name__)
 def _on_milestone_complete(original, self, *args, **kwargs):
     result = original(self, *args, **kwargs)
     OnMilestoneCompletionEvent.get()._on_milestone_completion(*args, **kwargs)
@@ -42,9 +40,9 @@ class OnMilestoneCompletionEvent(CommonService):
 
     def _on_milestone_completion(self, aspiration, *_, **__):
         if aspiration.aspiration_type == AspriationType.FULL_ASPIRATION:
-            if aspiration.is_valid_for_sim(CommonSimUtils.get_active_sim_info()):
+            if aspiration.is_valid_for_sim(S4APSimUtils.get_active_sim_info()):
                 aspiration_display_name = aspiration.display_name
-                track = CommonSimUtils.get_active_sim_info().primary_aspiration
+                track = S4APSimUtils.get_active_sim_info().primary_aspiration
                 track_display_text = track.display_text  # this takes the primary aspiration name as a LocalizedString object
                 return CommonEventRegistry.get().dispatch(
                     MilestoneCompletion(track_display_text, aspiration_display_name, aspiration))

Scripts/s4ap/events/career_event_dispatcher.py

@@ -3,17 +3,18 @@
 from s4ap.events.checks.send_check_event import SendLocationEvent
 from s4ap.logging.s4ap_logger import S4APLogger
 from s4ap.modinfo import ModInfo
+from s4ap.utils.s4ap_household_utils import S4APHouseholdUtils
+from s4ap.utils.s4ap_sim_utils import S4APSimUtils
 from sims4communitylib.events.event_handling.common_event import CommonEvent
 from sims4communitylib.events.event_handling.common_event_registry import CommonEventRegistry
 from sims4communitylib.services.common_service import CommonService
-from sims4communitylib.utils.common_injection_utils import CommonInjectionUtils
-from sims4communitylib.utils.sims.common_household_utils import CommonHouseholdUtils
+from lot51_core.utils.injection import inject_to
 
 log = S4APLogger.get_log()
 log.enable()
 
 
-class CarrerPromotionEvent(CommonEvent):
+class CareerPromotionEvent(CommonEvent):
     def __init__(self, career, current_level):
         self._career = career
         self._current_level = current_level
@@ -29,25 +30,26 @@ def current_level(self):
 
 class OnCareerPromotionEvent(CommonService):
 
-    def _on_promotion(self, career, user_level: int, *_, **__):
-        log.debug(f'here is the career: {career}')
-        CommonEventRegistry.get().dispatch(CarrerPromotionEvent(career, user_level))
+    def _on_promotion(self, career, user_level: int, name: str, *_, **__):
+        career_name = HashLookup().get_career_name(career, user_level)
+        log.debug(f'here is the career: {career} {user_level} ({career_name})')
+        log.debug(f'{name} was promoted to {career_name}')
+        CommonEventRegistry.get().dispatch(CareerPromotionEvent(career, user_level))
 
-
-@CommonInjectionUtils.inject_safely_into(ModInfo.get_identity(), CareerBase,
-                                         CareerBase._handle_promotion.__name__, handle_exceptions=True)
+@inject_to(CareerBase, CareerBase._handle_promotion.__name__)
 def _on_milestone_complete(original, self, *args, **kwargs):
     result = original(self, *args, **kwargs)
     career = self._current_track.get_career_name(self._sim_info).hash
     level = self._user_level
     sim_info = self._sim_info
-    if sim_info in CommonHouseholdUtils.get_sim_info_of_all_sims_in_active_household_generator():
-        OnCareerPromotionEvent.get()._on_promotion(career, level)
+    if sim_info in S4APHouseholdUtils.get_sim_info_of_all_sims_in_active_household_generator():
+        sim_name = S4APSimUtils.get_sim_first_name(sim_info)
+        OnCareerPromotionEvent.get()._on_promotion(career, level, sim_name)
     return result
 
 
 @CommonEventRegistry.handle_events(ModInfo.get_identity())
-def _send_notif_on_event_handle(event_data: CarrerPromotionEvent):
+def _send_notif_on_event_handle(event_data: CareerPromotionEvent):
     lookup = HashLookup()
     CommonEventRegistry.get().dispatch(
         SendLocationEvent(f'{lookup.get_career_name(event_data.career, event_data.current_level)}'))

Scripts/s4ap/events/checks/send_check_event.py

@@ -1,10 +1,10 @@
+from lot51_core.utils.dialog import DialogHelper
 from s4ap.events.Utils.send_location_event import SendLocationEvent
 from s4ap.jsonio.s4ap_json import print_json, read_json
 from s4ap.logging.s4ap_logger import S4APLogger
 from s4ap.modinfo import ModInfo
 from s4ap.utils.s4ap_generic_utils import S4APUtils
 from sims4communitylib.events.event_handling.common_event_registry import CommonEventRegistry
-from sims4communitylib.notifications.common_basic_notification import CommonBasicNotification
 
 logger = S4APLogger.get_log()
 logger.enable()
@@ -36,9 +36,8 @@ def _handle_send_check_event(event_data: SendLocationEvent):
     if event_data.location_name not in json_list["Locations"]:
         json_list["Locations"].append(event_data.location_name)
         print_json(json_list, 'locations_cached.json')
-        notif = CommonBasicNotification(
-            title_identifier='Saving on check',
-            description_identifier=event_data.location_name
-        )
-        notif.show()
+        DialogHelper.create_notification(
+            'Saving on check',
+            event_data.location_name
+        ).show_dialog()
         S4APUtils.trigger_autosave()

Scripts/s4ap/events/items/receive_item_event.py

@@ -1,20 +1,22 @@
 import time
 
+from lot51_core.utils.dialog import DialogHelper
+from protocolbuffers import Consts_pb2
+
 from s4ap.enums.S4APLocalization import S4APTraitId
 from s4ap.logging.s4ap_logger import S4APLogger
 from s4ap.modinfo import ModInfo
 from s4ap.persistance.ap_session_data_store import S4APSessionStoreUtils
+from s4ap.utils.s4ap_career_utils import S4APCareerUtils
+from s4ap.utils.s4ap_generic_utils import S4APUtils
+from s4ap.utils.s4ap_household_utils import S4APHouseholdUtils
+from s4ap.utils.s4ap_sim_currency_utils import S4APSimCurrencyUtils
+from s4ap.utils.s4ap_sim_utils import S4APSimUtils
 from s4ap.utils.s4ap_skill_utils import lock_skills
-from sims4communitylib.enums.common_currency_modify_reasons import CommonCurrencyModifyReason
+from s4ap.utils.s4ap_trait_utils import S4APTraitUtils
+from sims4.resources import Types
 from sims4communitylib.events.event_handling.common_event import CommonEvent
 from sims4communitylib.events.event_handling.common_event_registry import CommonEventRegistry
-from sims4communitylib.notifications.common_basic_notification import CommonBasicNotification
-from sims4communitylib.utils.sims.common_career_utils import CommonCareerUtils
-from sims4communitylib.utils.sims.common_household_utils import CommonHouseholdUtils
-from sims4communitylib.utils.sims.common_sim_career_utils import CommonSimCareerUtils
-from sims4communitylib.utils.sims.common_sim_currency_utils import CommonSimCurrencyUtils
-from sims4communitylib.utils.sims.common_sim_utils import CommonSimUtils
-from sims4communitylib.utils.sims.common_trait_utils import CommonTraitUtils
 from collections import Counter
 log = S4APLogger.get_log()
 log.enable()
@@ -129,16 +131,16 @@ def handle_items(self, items):
             log.debug(f'Processing {item}')
             if 'Simoleons' in item:  # Simoleon items are either '5000 Simoleons' or '2000 Simoleons'
                 number = item.split()[0]
-                CommonSimCurrencyUtils.add_simoleons_to_household(CommonSimUtils.get_active_sim_info(), int(number),
-                                                                  CommonCurrencyModifyReason.CHEAT)
+                S4APSimCurrencyUtils.add_simoleons_to_household(S4APSimUtils.get_active_sim_info(), int(number),
+                                                                  Consts_pb2.TELEMETRY_MONEY_CHEAT)
                 time.sleep(0.2)
             elif 'boost' in item.lower():
                 if 'career' in item.lower():
-                    for sim_info in CommonHouseholdUtils.get_sim_info_of_all_sims_in_active_household_generator():
-                        for career in CommonSimCareerUtils.get_all_careers_for_sim_gen(sim_info):
+                    for sim_info in S4APHouseholdUtils.get_sim_info_of_all_sims_in_active_household_generator():
+                        for career in S4APCareerUtils.get_all_careers_for_sim_gen(sim_info):
                             if career is None:
                                 break
-                            old_work_performance = CommonCareerUtils.get_work_performance(career)
+                            old_work_performance = S4APCareerUtils.get_work_performance(career)
                             work_performance_left_to_add = 100 - old_work_performance
                             career.add_work_performance(work_performance_left_to_add)
                             career.resend_career_data()
@@ -157,10 +159,12 @@ def handle_items(self, items):
                     rem_traits = (S4APTraitId.SKILL_GAIN_BOOST_2_5X, S4APTraitId.SKILL_GAIN_BOOST_3X,
                                   S4APTraitId.SKILL_GAIN_BOOST_3_5X)
                     add_trait = S4APTraitId.SKILL_GAIN_BOOST_4X
-                for sim_info in CommonHouseholdUtils.get_sim_info_of_all_sims_in_active_household_generator():
+                for sim_info in S4APHouseholdUtils.get_sim_info_of_all_sims_in_active_household_generator():
                     if rem_traits is not None:
-                        CommonTraitUtils.remove_traits(sim_info, rem_traits)
-                    CommonTraitUtils.add_trait(sim_info, add_trait)
+                        S4APTraitUtils.remove_traits(sim_info, rem_traits)
+                    trait_obj = S4APUtils.load_instance(Types.TRAIT, add_trait)
+                    if trait_obj and not sim_info.has_trait(trait_obj):
+                        sim_info.add_trait(trait_obj)
             elif 'skill' in item.lower():
                 count = data_store.get_items().count(item)
                 count += 2
@@ -175,9 +179,9 @@ def handle_items(self, items):
                     skill = skill.lower().replace('mixology', 'bartending')
                 lock_skills(count, skill, False)
 
-    def show_received_notification(self, items, players, locations):
-        notif = CommonBasicNotification(
-            title_identifier='Received Items',
-            description_identifier='\n'.join(
-                [f'{item} from {player} ({location})' for item, player, location in zip(items, players, locations)]))
-        notif.show()
+    @staticmethod
+    def show_received_notification(items, players, locations):
+        DialogHelper.create_notification(
+            'Received Items',
+            '\n'.join(
+                [f'{item} from {player} ({location})' for item, player, location in zip(items, players, locations)])).show_dialog()

Scripts/s4ap/events/skill_event_dispatcher.py

@@ -1,58 +1,29 @@
 import re
 
 from s4ap.events.checks.send_check_event import SendLocationEvent
+from s4ap.events.skill_events import SimSkillLeveledUpEvent
 from s4ap.logging.s4ap_logger import S4APLogger
 from s4ap.modinfo import ModInfo
+from s4ap.utils.s4ap_sim_utils import S4APSimUtils
+from s4ap.utils.s4ap_skill_utils_class import S4APSkillUtils
 from sims.sim_info import SimInfo
-from sims4communitylib.events.event_handling.common_event import CommonEvent
 from sims4communitylib.events.event_handling.common_event_registry import CommonEventRegistry
 from sims4communitylib.services.common_service import CommonService
-from sims4communitylib.utils.common_injection_utils import CommonInjectionUtils
-from sims4communitylib.utils.resources.common_skill_utils import CommonSkillUtils
-from sims4communitylib.utils.sims.common_sim_utils import CommonSimUtils
+from lot51_core.utils.injection import inject_to
 from statistics.skill import Skill
 
 logger = S4APLogger.get_log()
 
 
-class SimSkillLeveledUpEvent(CommonEvent):
-
-    def __init__(self, sim_info: SimInfo, skill: Skill, new_skill_level: int):
-        self._sim_info = sim_info
-        self._skill = skill
-        self._new_skill_level = new_skill_level
-
-    @property
-    def new_skill_level(self) -> int:
-        """The level the Sim will be after leveling up."""
-        return self._new_skill_level
-
-    @property
-    def sim_info(self) -> SimInfo:
-        """The Sim that leveled up in a Skill."""
-        return self._sim_info
-
-    @property
-    def skill(self) -> Skill:
-        """The Skill that was leveled up."""
-        return self._skill
-
-    @property
-    def skill_id(self) -> int:
-        """The decimal identifier of the Skill."""
-        return CommonSkillUtils.get_skill_id(self.skill)
-
-
 class HandleSkillLevelUp(CommonService):
     def _on_skill_updated(self, skill: Skill, new_skill_level: int) -> None:
         if skill.tracker is None or skill.tracker._owner is None:
             return
         if not skill.tracker._owner.is_npc:
-            sim_info = CommonSimUtils.get_sim_info(skill.tracker._owner)
+            sim_info = S4APSimUtils.get_sim_info(skill.tracker._owner)
             CommonEventRegistry.get().dispatch(SimSkillLeveledUpEvent(sim_info, skill, new_skill_level))
 
-
-@CommonInjectionUtils.inject_safely_into(ModInfo.get_identity(), Skill, Skill._handle_skill_up.__name__)
+@inject_to(Skill, Skill._handle_skill_up.__name__)
 def _common_on_sim_skill_level_up(original, self, *args, **kwargs):
     result = original(self, *args, **kwargs)
     HandleSkillLevelUp.get()._on_skill_updated(self, *args, **kwargs)

Scripts/s4ap/events/skill_events.py

@@ -0,0 +1,34 @@
+from typing import Optional
+
+from sims.sim_info import SimInfo
+from sims4communitylib.events.event_handling.common_event import CommonEvent
+from statistics.skill import Skill
+
+
+class SimSkillLeveledUpEvent(CommonEvent):
+
+    def __init__(self, sim_info: SimInfo, skill: Skill, new_skill_level: int):
+        self._sim_info = sim_info
+        self._skill = skill
+        self._new_skill_level = new_skill_level
+
+    @property
+    def new_skill_level(self) -> int:
+        """The level the Sim will be after leveling up."""
+        return self._new_skill_level
+
+    @property
+    def sim_info(self) -> SimInfo:
+        """The Sim that leveled up in a Skill."""
+        return self._sim_info
+
+    @property
+    def skill(self) -> Skill:
+        """The Skill that was leveled up."""
+        return self._skill
+
+    @property
+    def skill_id(self) -> Optional[int]:
+        """The decimal identifier of the Skill, or None if the Skill has no guid64 attribute."""
+        from s4ap.utils.s4ap_skill_utils_class import S4APSkillUtils
+        return S4APSkillUtils.get_skill_id(self.skill)