Welcome to BluuberryLibrary’s documentation!

BluuberryLibrary (/lu’make/) is a Python library for creating Script mods in The Sims 4 It offers a wide range of utilities and classes for making script mods easier to both make and manage.

Check out the sections on the left or below for various utilities.

Note

This project is under active development.

Contents

• Classes
  • BB Singleton
    • BBSingleton
  • BB Enqueue Interaction Result
    • BBEnqueueInteractionResult
      • BBEnqueueInteractionResult.from_base()
      • BBEnqueueInteractionResult.to_base()
  • BB Execute Interaction Result
    • BBExecuteInteractionResult
      • BBExecuteInteractionResult.from_base()
      • BBExecuteInteractionResult.to_base()
  • BB Run Result
    • BBRunResult
      • BBRunResult.from_base()
      • BBRunResult.to_base()
  • BB Test Result
    • BBTestResult
      • BBTestResult.from_base()
      • BBTestResult.reverse()
• Notifications
  • BB Value Dialog
  • BB Value Picker Row
• Dialog Icons
  • Icon Info
    • BBIconInfo
      • BBIconInfo.to_icon()
  • Sim Icon Info
    • BBSimIconInfo
• Notifications
  • BB Notification
    • BBNotification
      • BBNotification.show()
  • BB Dialog Response
    • BBDialogResponse
• Enums
  • Interaction Ids
  • BB Component Types
  • BB Int
    • BBInt
  • BB Int Flags
    • BBIntFlags
• Event Handling
  • Event
    • BBEvent
      • BBEvent.mod_identity
  • Event Handler
    • BBEventHandler
      • BBEventHandler.event_type
      • BBEventHandler.handler
      • BBEventHandler.mod_identity
  • Event Handler Registry
    • BBEventHandlerRegistry
      • BBEventHandlerRegistry.dispatch()
      • BBEventHandlerRegistry.register()
      • BBEventHandlerRegistry.register_handler()
      • BBEventHandlerRegistry.unregister_handler()
• Interaction Events
  • Interaction Completed Event
    • BBOnInteractionCompletedEvent
      • BBOnInteractionCompletedEvent.finished_naturally
      • BBOnInteractionCompletedEvent.interaction
      • BBOnInteractionCompletedEvent.sim_info
      • BBOnInteractionCompletedEvent.target
      • BBOnInteractionCompletedEvent.was_user_cancelled
• Sim Events
  • Sim Spawned Event
    • BBOnSimSpawnedEvent
      • BBOnSimSpawnedEvent.sim_info
  • Sim Despawned Event
    • BBOnSimDespawnedEvent
      • BBOnSimDespawnedEvent.sim_info
  • Sim Died Event
    • BBOnSimDiedEvent
      • BBOnSimDiedEvent.sim_info
  • Sim Resurrected Event
    • BBOnSimResurrectedEvent
      • BBOnSimResurrectedEvent.sim_info
• Zone Events
  • Zone Load Start Event
    • BBOnZoneLoadStartEvent
      • BBOnZoneLoadStartEvent.is_first_load
      • BBOnZoneLoadStartEvent.zone
  • Zone Load End Event
    • BBOnZoneLoadEndEvent
      • BBOnZoneLoadEndEvent.household_id
      • BBOnZoneLoadEndEvent.is_build_mode
      • BBOnZoneLoadEndEvent.is_first_load
      • BBOnZoneLoadEndEvent.zone
  • Zone Unload Start Event
    • BBOnZoneUnloadStartEvent
      • BBOnZoneUnloadStartEvent.client
      • BBOnZoneUnloadStartEvent.zone
  • Zone Event Dispatcher
    • BBZoneEventDispatcher
      • BBZoneEventDispatcher.client_finished_first_load
      • BBZoneEventDispatcher.client_is_loading
      • BBZoneEventDispatcher.on_zone_load_finished()
      • BBZoneEventDispatcher.on_zone_load_started()
      • BBZoneEventDispatcher.on_zone_unload_started()
• Interactions
  • Immediate Super Interaction
    • BBImmediateSuperInteraction
      • BBImmediateSuperInteraction.get_log_name()
      • BBImmediateSuperInteraction.get_mod_identity()
  • Super Interaction
    • BBSuperInteraction
      • BBSuperInteraction.get_log_name()
      • BBSuperInteraction.get_mod_identity()
  • Social Super Interaction
    • BBSocialSuperInteraction
      • BBSocialSuperInteraction.get_log_name()
      • BBSocialSuperInteraction.get_mod_identity()
  • Social Mixer Interaction
    • BBSocialMixerInteraction
      • BBSocialMixerInteraction.get_log_name()
      • BBSocialMixerInteraction.get_mod_identity()
  • Mixer Interaction
    • BBMixerInteraction
      • BBMixerInteraction.get_log_name()
      • BBMixerInteraction.get_mod_identity()
• Interaction Registration
  • Interaction Registry
    • BBInteractionRegistry
      • BBInteractionRegistry.register()
      • BBInteractionRegistry.register_interaction_handler()
  • Interaction Handler
    • BBInteractionHandler
      • BBInteractionHandler.interaction_guids
      • BBInteractionHandler.registration_location
      • BBInteractionHandler.should_register()
  • Interaction Location
    • BBInteractionLocation
  • Object Interaction Handler
    • BBObjectInteractionHandler
      • BBObjectInteractionHandler.interaction_guids
      • BBObjectInteractionHandler.registration_location
      • BBObjectInteractionHandler.should_register()
  • Sim Interaction Handler
    • BBSimInteractionHandler
      • BBSimInteractionHandler.interaction_guids
      • BBSimInteractionHandler.registration_location
      • BBSimInteractionHandler.should_register()
  • Terrain Interaction Handler
    • BBTerrainInteractionHandler
      • BBTerrainInteractionHandler.interaction_guids
      • BBTerrainInteractionHandler.registration_location
      • BBTerrainInteractionHandler.should_register()
  • Ocean Interaction Handler
    • BBOceanInteractionHandler
      • BBOceanInteractionHandler.interaction_guids
      • BBOceanInteractionHandler.registration_location
      • BBOceanInteractionHandler.should_register()
  • Phone Interaction Handler
    • BBPhoneInteractionHandler
      • BBPhoneInteractionHandler.interaction_guids
      • BBPhoneInteractionHandler.registration_location
      • BBPhoneInteractionHandler.should_register()
  • Relationship Panel Interaction Handler
    • BBRelationshipPanelInteractionHandler
      • BBRelationshipPanelInteractionHandler.interaction_guids
      • BBRelationshipPanelInteractionHandler.registration_location
      • BBRelationshipPanelInteractionHandler.should_register()
• Logs
  • Log
    • BBLog
      • BBLog.debug()
      • BBLog.disable()
      • BBLog.enable()
      • BBLog.error()
      • BBLog.is_enabled()
      • BBLog.log_stack()
      • BBLog.mod_name
      • BBLog.name
  • Log Registry
    • BBLogRegistry
      • BBLogRegistry.disable_logs()
      • BBLogRegistry.enable_logs()
      • BBLogRegistry.register_log()
  • Stacktrace Utils
    • BBStacktraceUtils
      • BBStacktraceUtils.current_stack()
      • BBStacktraceUtils.get_full_stack_trace()
  • Log Mixin
    • BBLogMixin
      • BBLogMixin.get_log()
      • BBLogMixin.get_log_name()
      • BBLogMixin.get_mod_identity()
• Mod Registration
  • Mod Identity
    • BBModIdentity
      • BBModIdentity.mod_author
      • BBModIdentity.mod_name
      • BBModIdentity.mod_version
      • BBModIdentity.module_namespace
      • BBModIdentity.script_file_path
• Debug Utilities
  • Injection
    • BBInjectionUtils
      • BBInjectionUtils.inject()
• Environment Utilities
  • Weather Utils
    • BBWeatherUtils
      • BBWeatherUtils.get_weather_service()
      • BBWeatherUtils.load_weather_event_by_guid()
      • BBWeatherUtils.trigger_weather_event()
• File Utilities
  • File Utils
    • BBFileUtils
      • BBFileUtils.delete_directory()
      • BBFileUtils.delete_file()
      • BBFileUtils.read_file()
      • BBFileUtils.write_file()
  • Game File Utils
    • BBGameFileUtils
      • BBGameFileUtils.get_the_sims_4_file_path()
• Instance Utilities
  • Buff Utils
    • BBBuffUtils
      • BBBuffUtils.load_buff_by_guid()
  • Component Utils
    • BBComponentUtils
      • BBComponentUtils.add_component()
      • BBComponentUtils.get_component()
  • Interaction Utils
    • BBInteractionUtils
      • BBInteractionUtils.get_interaction_short_name()
      • BBInteractionUtils.is_immediate_super_interaction()
      • BBInteractionUtils.is_mixer_interaction()
      • BBInteractionUtils.is_social_mixer_interaction()
      • BBInteractionUtils.is_social_super_interaction()
      • BBInteractionUtils.is_super_interaction()
      • BBInteractionUtils.load_interaction_by_guid()
      • BBInteractionUtils.to_interaction_guid()
  • Instance Utils
  • Situation Utils
    • BBSituationUtils
      • BBSituationUtils.get_situation_guid()
      • BBSituationUtils.get_situation_job_name()
      • BBSituationUtils.get_situation_name()
      • BBSituationUtils.get_situation_role_name()
      • BBSituationUtils.load_situation_by_guid()
  • Statistic Utils
  • Trait Utils
    • BBTraitUtils
      • BBTraitUtils.get_trait_guid()
      • BBTraitUtils.get_trait_name()
      • BBTraitUtils.load_trait_by_guid()
• Location Utilities
  • Zone Modifier Utils
    • BBZoneModifierUtils
      • BBZoneModifierUtils.add_zone_modifier()
      • BBZoneModifierUtils.add_zone_modifier_to_current_lot()
      • BBZoneModifierUtils.load_zone_modifier_by_guid()
• Object Utilities
  • Object Spawn Utils
    • BBObjectSpawnUtils
      • BBObjectSpawnUtils.create_object()
      • BBObjectSpawnUtils.spawn_object_at_location()
  • Object State Utils
• Sim Utilities
  • Sim Interaction Utils
    • BBSimInteractionUtils
      • BBSimInteractionUtils.get_queued_interactions_gen()
      • BBSimInteractionUtils.get_running_interactions_gen()
  • Sim Buff Utils
    • BBSimBuffUtils
      • BBSimBuffUtils.add_buff()
      • BBSimBuffUtils.can_add_buff()
      • BBSimBuffUtils.has_buff()
      • BBSimBuffUtils.remove_buff()
  • Sim Situation Utils
    • BBSimSituationUtils
      • BBSimSituationUtils.get_situation_job()
      • BBSimSituationUtils.get_situation_role()
      • BBSimSituationUtils.get_situations()
  • Sim Spawn Utils
    • BBSimSpawnUtils
      • BBSimSpawnUtils.create_sim_info()
      • BBSimSpawnUtils.spawn_sim()
  • Sim Statistic Utils
  • Sim Trait Utils
    • BBSimTraitUtils
      • BBSimTraitUtils.add_trait()
      • BBSimTraitUtils.can_add_trait()
      • BBSimTraitUtils.get_traits()
      • BBSimTraitUtils.has_trait()
      • BBSimTraitUtils.remove_trait()
  • Sim Utils
    • BBSimUtils
      • BBSimUtils.get_active_sim_info()
      • BBSimUtils.get_all_sim_info_gen()
      • BBSimUtils.get_sim_info_manager()
      • BBSimUtils.to_sim_id()
      • BBSimUtils.to_sim_info()
      • BBSimUtils.to_sim_instance()
• Text Utilities
  • Localization Utils
    • BBLocalizationUtils
      • BBLocalizationUtils.combine_strings()
      • BBLocalizationUtils.to_localized_string()
      • BBLocalizationUtils.to_localized_tooltip()
  • Localized Tooltip
• Time Utilities
  • Date Utils
    • BBDateTimeUtils
      • BBDateTimeUtils.get_current_real_date_time()
      • BBDateTimeUtils.get_current_real_date_time_string()