play

Documentation

Overview

Low level communication between a game console and a running game. None of these commands are available for use in game scripts.

Index

• Variables
• type PlayLog
  • func (op *PlayLog) GetMarkup(ensure bool) map[string]any
  • func (*PlayLog) PlayMessage()
  • func (*PlayLog) TypeInfo() typeinfo.T
• type PlayLog_Slice
  • func (op *PlayLog_Slice) Repeats() bool
  • func (*PlayLog_Slice) TypeInfo() typeinfo.T
• type PlayMessage
• type PlayMessage_Slot
  • func (*PlayMessage_Slot) TypeInfo() typeinfo.T
• type PlayMessage_Slots
  • func (op *PlayMessage_Slots) Repeats() bool
  • func (*PlayMessage_Slots) TypeInfo() typeinfo.T
• type PlayMode
  • func (op *PlayMode) GetMarkup(ensure bool) map[string]any
  • func (*PlayMode) PlayMessage()
  • func (*PlayMode) TypeInfo() typeinfo.T
• type PlayMode_Slice
  • func (op *PlayMode_Slice) Repeats() bool
  • func (*PlayMode_Slice) TypeInfo() typeinfo.T
• type PlayModes
  • func MakePlayModes(str string) (ret PlayModes, okay bool)
  • func (op PlayModes) String() (ret string)
• type PlayOut
  • func (op *PlayOut) GetMarkup(ensure bool) map[string]any
  • func (*PlayOut) PlayMessage()
  • func (*PlayOut) TypeInfo() typeinfo.T
• type PlayOut_Slice
  • func (op *PlayOut_Slice) Repeats() bool
  • func (*PlayOut_Slice) TypeInfo() typeinfo.T

Variables

var Z_Types = typeinfo.TypeSet{
	Name: "play",
	Comment: []string{
		"Low level communication between a game console and a running game.",
		"None of these commands are available for use in game scripts.",
	},

	Slot:       z_slot_list,
	Flow:       z_flow_list,
	Str:        z_str_list,
	Signatures: z_signatures,
}

package listing of type data

var Zt_PlayLog typeinfo.Flow

play_log, a type of flow.

var Zt_PlayMessage = typeinfo.Slot{
	Name: "play_message",
	Markup: map[string]any{
		"comment": "A client-server message for the play app.",
	},
}

play_message, a type of slot.

var Zt_PlayMode typeinfo.Flow

play_mode, a type of flow.

var Zt_PlayModes = typeinfo.Str{
	Name: "play_modes",
	Options: []string{
		"asm",
		"play",
		"complete",
		"error",
	},
	Markup: map[string]any{
		"comment": "One of the app level states communicated by [PlayMode].",
	},
}

play_modes, a type of str enum.

var Zt_PlayOut typeinfo.Flow

play_out, a type of flow.

Types

type PlayLog

type PlayLog struct {
	Log    string
	Markup map[string]any
}

A log message that might be displayed to the client for debugging.

func (*PlayLog) GetMarkup

func (op *PlayLog) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*PlayLog) PlayMessage

func (*PlayLog) PlayMessage()

func (*PlayLog) TypeInfo

func (*PlayLog) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type PlayLog_Slice

type PlayLog_Slice []PlayLog

Holds a slice of type PlayLog.

func (*PlayLog_Slice) Repeats

func (op *PlayLog_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of PlayLog.

func (*PlayLog_Slice) TypeInfo

func (*PlayLog_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of PlayLog.

type PlayMessage

type PlayMessage interface {
	PlayMessage()
	typeinfo.Instance
}

marker interface for play message types

type PlayMessage_Slot

type PlayMessage_Slot struct{ Value PlayMessage }

Holds a single slot.

func (*PlayMessage_Slot) TypeInfo

func (*PlayMessage_Slot) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a single slot.

type PlayMessage_Slots

type PlayMessage_Slots []PlayMessage

Holds a slice of slots.

func (*PlayMessage_Slots) Repeats

func (op *PlayMessage_Slots) Repeats() bool

Implements typeinfo.Repeats for a slice of slots.

func (*PlayMessage_Slots) TypeInfo

func (*PlayMessage_Slots) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of slots.

type PlayMode

type PlayMode struct {
	Mode   PlayModes
	Markup map[string]any
}

An app level change in state.

func (*PlayMode) GetMarkup

func (op *PlayMode) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*PlayMode) PlayMessage

func (*PlayMode) PlayMessage()

func (*PlayMode) TypeInfo

func (*PlayMode) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type PlayMode_Slice

type PlayMode_Slice []PlayMode

Holds a slice of type PlayMode.

func (*PlayMode_Slice) Repeats

func (op *PlayMode_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of PlayMode.

func (*PlayMode_Slice) TypeInfo

func (*PlayMode_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of PlayMode.

type PlayModes

type PlayModes int

One of the app level states communicated by PlayMode.

const (
	C_PlayModes_Asm PlayModes = iota
	C_PlayModes_Play
	C_PlayModes_Complete
	C_PlayModes_Error
)

The enumerated values of PlayModes.

func MakePlayModes

func MakePlayModes(str string) (ret PlayModes, okay bool)

func (PlayModes) String

func (op PlayModes) String() (ret string)

type PlayOut

type PlayOut struct {
	Out    string
	Markup map[string]any
}

Text that should be displayed to the player.

func (*PlayOut) GetMarkup

func (op *PlayOut) GetMarkup(ensure bool) map[string]any

Implements typeinfo.Markup

func (*PlayOut) PlayMessage

func (*PlayOut) PlayMessage()

func (*PlayOut) TypeInfo

func (*PlayOut) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type PlayOut_Slice

type PlayOut_Slice []PlayOut

Holds a slice of type PlayOut.

func (*PlayOut_Slice) Repeats

func (op *PlayOut_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of PlayOut.

func (*PlayOut_Slice) TypeInfo

func (*PlayOut_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of PlayOut.