Get Mission Description

Mission.get_mission_description

Parameters

mission_entity_id	Entity ID of the mission currently accessing the mission script

Returns

String The localization key for the mission description.

Description

Event handler that returns the localization key used to display the mission description in the mission info window and mission result window. This event handler is invoked during the initialization of the mission.

# Set the localized term for mission_description 
localization.SetTerm("en", "mission_description", "Mission description")
 
@event_handler(MissionEvent.GET_MISSION_DESCRIPTION)
def get_mission_description(mission_entity_id):\
    # Return the key for the localized mission description description
    return "mission_description"

⚠️ Localization key needs to be unique to avoid conflicts with other localization entries ⚠️