zoi_group.get_info

Overview

• Returns group information for the specified character: group_id, type, leader, all members with display names, and group options. Returns has_group=false if not in a group.

Metadata

Field	Value
Display	Get Zoi Group Info
Category	zoi_group
Access	Public
Scope	B2Authority
Tags	—
Aliases	—

Parameters

Name	Type	Required	Default	Description
entity_id	entityId	no	—	Character entity ID (default: possessed)

Returns

• Freeform result (shape is not fixed).

If not in a group: { has_group: false, entity_id: int }. If in a group: { has_group: true, group_id: int, type: string, leader_entity_id: int, members: [ { entity_id: int, display_name: string, is_leader: bool } ], member_count: int, options: { act_near_group: bool, leader_autonomy_only: bool } }.

Usage

await inzoi.cli.execute('zoi_group.get_info', {
  entity_id: 0, // optional
});