@my-swu/simulator-client

---

@my-swu/simulator-client / interactionCueMessage

Function: interactionCueMessage()

interactionCueMessage(cue): ClientMessage

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

Builds one transient hand-card interaction cue socket message.

Cues are live presentation hints only. They do not mutate gameplay state, history, replay, or saves; the server adds the sender seat before broadcast.

Example:

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

// Cues are presentation-only hints; they never mutate gameplay state.
const clientMessage = interactionCueMessage({
  kind: 'handCard',
  index: 0,
  state: 'hover',
})

console.log(clientMessage.type)

Parameters

cue

Example:

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

// Cues are presentation-only hints; they never mutate gameplay state.
const clientMessage = interactionCueMessage({
  kind: 'handCard',
  index: 0,
  state: 'hover',
})

console.log(clientMessage.type)

CardInteractionCueRequest

Returns

ClientMessage

Example

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

const clientMessage = interactionCueMessage({
  kind: 'handCard',
  index: 0,
  state: 'hover',
})
console.log(clientMessage.type)

See

https://simulator-sdk.my-swu.com/guide/websocket