Skip to main content

UgsModeration

24 tools in this family (folder Editor/Tools/UgsModeration/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
ugs_moderation_auto_apply_policywritesEnd-to-end pipeline: submit text OR voice → analyze → resolve the matching policy escalation tier
ugs_moderation_ban_playerdestructiveBan a player. duration_sec = -1 means PERMANENT BAN (requires confirm=true) and is irreversible
ugs_moderation_batch_submit_textread-onlySubmit an array of text strings to Safe Text in a single call — useful for batch-moderating chat
ugs_moderation_delete_custom_filterwritesDelete a custom word filter by name. Subsequent ugs_moderation_submit_text calls will no longer
ugs_moderation_disable_vivox_autowritesDisable the Vivox auto-moderation sampling loop. The EditorApplication update tick is unwired and
ugs_moderation_emit_chat_filter_middlewarewritesEmit a drop-in chat filter middleware C# script that wraps any text-chat backend (Friends DM,
ugs_moderation_emit_report_dialogwritesEmit an in-game F1 'Report Player' dialog as a UI Toolkit UXML file + MonoBehaviour C# handler.
ugs_moderation_enable_vivox_autowritesEnable auto-moderation on every joined Vivox channel. Every 'sample_every_sec' seconds the bridge
ugs_moderation_export_audit_logread-onlyExport the full moderation audit log (every enforcement record + every report ticket) as either
ugs_moderation_get_player_statusread-onlyReturn the aggregate moderation state for a player: active mutes, active bans, warnings, total
ugs_moderation_get_policyread-onlyReturn the active moderation policy: per-category thresholds, escalation tiers (severity band →
ugs_moderation_initwritesInitialize UGS Moderation (Safe Voice + Safe Text). Verifies UGS Authentication is initialized +
ugs_moderation_kick_playerwritesKick a player from a session. session_id is the active game session / match id. Kicks expire after
ugs_moderation_list_custom_filtersread-onlyList every registered custom word filter (name + word count + timestamps). The 'words' array on
ugs_moderation_list_reportsread-onlyList player report tickets, ordered by created_utc descending. Optional filters: 'status'
ugs_moderation_mute_playerwritesMute a player for a fixed duration. When the ugs_vivox_* family is present, the mute is also
ugs_moderation_register_custom_filterwritesRegister (or update) a custom word filter — a named list of words/phrases that Safe Text will hit-
ugs_moderation_resolve_reportwritesResolve a player report by applying an enforcement action. action is one of: LogOnly, Warn,
ugs_moderation_set_policywritesReplace the active moderation policy. The policy is a JSON object with 'thresholds' (per-category
ugs_moderation_submit_reportwritesSubmit a player-on-player report ticket. The reporter is implicitly the currently signed-in UGS
ugs_moderation_submit_textwritesSubmit one text string (chat message, name, DM) to Safe Text. Returns per-category confidence
ugs_moderation_submit_voicewritesSubmit a voice clip to Safe Voice for toxicity analysis. Provide EITHER 'audio_base64' (raw bytes
ugs_moderation_unban_playerwritesLift every active ban for the given player by expiring it immediately. Historical enforcement
ugs_moderation_unmute_playerwritesLift every active mute for the given player by expiring it immediately. The historical