@my-swu/simulator-client

---

@my-swu/simulator-client / setAiPausedMessage

Function: setAiPausedMessage()

setAiPausedMessage(paused): ClientMessage

Defined in: packages/ts-sdk/src/messages.ts:94

Builds one setAiPaused socket message.

Use this for explicit manual control of an attached AI opponent without changing the underlying game state. Undo-created AI pauses resume automatically after the next successful human mutation.

Example:

import { setAiPausedMessage } from '@my-swu/simulator-client'

// AI pause frames control an attached AI opponent at the session level.
const clientMessage = setAiPausedMessage(true)

console.log(clientMessage.type)

Parameters

paused

Example:

import { setAiPausedMessage } from '@my-swu/simulator-client'

// AI pause frames control an attached AI opponent at the session level.
const clientMessage = setAiPausedMessage(true)

console.log(clientMessage.type)

boolean

Returns

ClientMessage

Example

import { setAiPausedMessage } from '@my-swu/simulator-client'

const clientMessage = setAiPausedMessage(true)
console.log(clientMessage.type)

See

https://simulator-sdk.my-swu.com/guide/driving-gameplay