def delete_sim(sim_info: SimInfo, cause: str = None) -> bool:
"""delete_sim(sim_info, cause=None)
Delete a Sim.
:param sim_info: The Sim to delete.
:type sim_info: SimInfo
:param cause: The reason for the deletion.
:type cause: str, optional
:return: True, if the Sim was deleted successfully. False, if not.
:rtype: bool
"""
if not CommonSimSpawnUtils.despawn_sim(sim_info, cause=cause):
return False
sim_info.remove_permanently()
return True
def delete_sim(sim_info: SimInfo, source: str=None, cause: str=None, **kwargs) -> bool:
"""delete_sim(sim_info, source=None, cause=None, **kwargs)
Delete a Sim.
:param sim_info: The Sim to delete.
:type sim_info: SimInfo
:param source: The source of the destruction. Default is None.
:type source: str, optional
:param cause: The cause of the destruction. Default is None.
:type cause: str, optional
:return: True, if the Sim was deleted successfully. False, if not.
:rtype: bool
"""
if not CommonSimSpawnUtils.despawn_sim(sim_info, source=source, cause=cause, **kwargs):
return False
sim_info.remove_permanently()
return True