PartyReorderedEvent
The party has a new marching order.
Full documentation: PartyReorderedEvent. Wire type: party_reordered.
Default visibility: player
Message codes: exploration.party.reordered
JSON Schema
{
"$defs": {
"Visibility": {
"description": "Who may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\n\nExamples:\n ```python\n from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n log = [\n DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n ]\n shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n assert shown == [\"combat.damage.dealt\"] # the goblin's remaining hit points stay hidden\n ```",
"enum": [
"player",
"referee"
],
"title": "Visibility",
"type": "string"
}
},
"description": "The party has a new marching order.\n\nEmitted by `ReorderParty`. Marching order is the order\nthe members walk in, front first, so redraw the party on screen in this order when the event\narrives. A member who withdraws or retreats in a battle also changes the order, and that change\narrives as a `MemberWithdrewEvent` instead.",
"properties": {
"code": {
"default": "exploration.party.reordered",
"title": "Code",
"type": "string",
"description": "The message code, always `exploration.party.reordered`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "player",
"description": "Player visibility: the players chose the order."
},
"event_type": {
"const": "party_reordered",
"default": "party_reordered",
"title": "Event Type",
"type": "string",
"description": "The event type, `party_reordered`, which identifies this class in serialized form."
},
"order": {
"items": {
"type": "string"
},
"title": "Order",
"type": "array",
"description": "Every member's id in the new marching order, front first, the same list the command\ngave."
}
},
"required": [
"order"
],
"title": "PartyReorderedEvent",
"type": "object"
}