EncounterGroupJoinedEvent
A new monster group joined the open encounter or battle, with what the party can see of it.
Full documentation: EncounterGroupJoinedEvent. Wire type: encounter_group_joined.
Default visibility: player
Message codes: encounter.group.joined
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": "A new monster group joined the open encounter or battle, with what the party can see of it.\n\nEmitted by `SpawnMonsters` when an encounter or a\nbattle is open, after the `MonstersSpawnedEvent`\nfor the same monsters. The players learn of the new group from this event, as they learn of\nthe first groups from `EncounterStartedEvent`.\nThe session rolls no surprise or reaction for the group. The group acts from the next round.",
"properties": {
"code": {
"default": "encounter.group.joined",
"title": "Code",
"type": "string",
"description": "The message code, always `encounter.group.joined`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "player",
"description": "Player visibility: the party sees the new monsters arrive."
},
"event_type": {
"const": "encounter_group_joined",
"default": "encounter_group_joined",
"title": "Event Type",
"type": "string",
"description": "The event type, `encounter_group_joined`, which identifies this class in serialized form."
},
"group_id": {
"title": "Group Id",
"type": "string",
"description": "The new group's id, the same as its\n`EncounterGroupView.id` in the player view. To\nattack the group, put this id in a battle declaration's `target_group_id`."
},
"label": {
"title": "Label",
"type": "string",
"description": "The group's `label`: what the party would call one\nof its members, like `\"goblin\"`."
},
"label_plural": {
"default": "",
"title": "Label Plural",
"type": "string",
"description": "The group's `label_plural`, like\n`\"goblins\"`, for a line like \"2 goblins\". An event loaded from a save that has no plural gets `label`\nwith the regular English ending."
},
"count": {
"title": "Count",
"type": "integer",
"description": "How many creatures are in the group."
},
"distance_feet": {
"title": "Distance Feet",
"type": "integer",
"description": "How far away the group is, in feet, when it joins."
}
},
"required": [
"group_id",
"label",
"count",
"distance_feet"
],
"title": "EncounterGroupJoinedEvent",
"type": "object"
}