frame

Documentation

Overview

Low level communication with a game server. None of these commands are available for use in game scripts.

Index

• Variables
• type Frame
  • func (op *Frame) GetMarkup(ensure bool) map[string]any
  • func (*Frame) TypeInfo() typeinfo.T
• type FrameOutput
  • func (op *FrameOutput) GetMarkup(ensure bool) map[string]any
  • func (*FrameOutput) TypeInfo() typeinfo.T
• type FrameOutput_Slice
  • func (op *FrameOutput_Slice) Repeats() bool
  • func (*FrameOutput_Slice) TypeInfo() typeinfo.T
• type Frame_Slice
  • func (op *Frame_Slice) Repeats() bool
  • func (*Frame_Slice) TypeInfo() typeinfo.T
• type Notification
• type Notification_Slot
  • func (*Notification_Slot) TypeInfo() typeinfo.T
• type Notification_Slots
  • func (op *Notification_Slots) Repeats() bool
  • func (*Notification_Slots) TypeInfo() typeinfo.T
• type PairChanged
  • func (op *PairChanged) GetMarkup(ensure bool) map[string]any
  • func (*PairChanged) TypeInfo() typeinfo.T
• type PairChanged_Slice
  • func (op *PairChanged_Slice) Repeats() bool
  • func (*PairChanged_Slice) TypeInfo() typeinfo.T
• type SceneEnded
  • func (op *SceneEnded) GetMarkup(ensure bool) map[string]any
  • func (*SceneEnded) TypeInfo() typeinfo.T
• type SceneEnded_Slice
  • func (op *SceneEnded_Slice) Repeats() bool
  • func (*SceneEnded_Slice) TypeInfo() typeinfo.T
• type SceneStarted
  • func (op *SceneStarted) GetMarkup(ensure bool) map[string]any
  • func (*SceneStarted) TypeInfo() typeinfo.T
• type SceneStarted_Slice
  • func (op *SceneStarted_Slice) Repeats() bool
  • func (*SceneStarted_Slice) TypeInfo() typeinfo.T
• type StateChanged
  • func (op *StateChanged) GetMarkup(ensure bool) map[string]any
  • func (*StateChanged) TypeInfo() typeinfo.T
• type StateChanged_Slice
  • func (op *StateChanged_Slice) Repeats() bool
  • func (*StateChanged_Slice) TypeInfo() typeinfo.T

Variables

var Z_Types = typeinfo.TypeSet{
	Name: "frame",
	Comment: []string{
		"Low level communication with a game server.",
		"None of these commands are available for use in game scripts.",
	},

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

package listing of type data

var Zt_Frame typeinfo.Flow

frame, a type of flow.

var Zt_FrameOutput typeinfo.Flow

frame_output, a type of flow.

var Zt_Notification = typeinfo.Slot{
	Name: "notification",
	Markup: map[string]any{
		"comment": "Marker interface used by all frame events.",
	},
}

notification, a type of slot.

var Zt_PairChanged typeinfo.Flow

pair_changed, a type of flow.

var Zt_SceneEnded typeinfo.Flow

scene_ended, a type of flow.

var Zt_SceneStarted typeinfo.Flow

scene_started, a type of flow.

var Zt_StateChanged typeinfo.Flow

state_changed, a type of flow.

Types

type Frame

type Frame struct {
	Result string
	Events []Notification
	Error  string
	Markup map[string]any
}

The results of a a player initiated turn, or other client to server query.

func (*Frame) GetMarkup

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

Implements typeinfo.Markup

func (*Frame) TypeInfo

func (*Frame) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type FrameOutput

type FrameOutput struct {
	Text   string
	Markup map[string]any
}

Printed text that should be visible the player.

func (*FrameOutput) GetMarkup

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

Implements typeinfo.Markup

func (*FrameOutput) TypeInfo

func (*FrameOutput) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type FrameOutput_Slice

type FrameOutput_Slice []FrameOutput

Holds a slice of type FrameOutput.

func (*FrameOutput_Slice) Repeats

func (op *FrameOutput_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of FrameOutput.

func (*FrameOutput_Slice) TypeInfo

func (*FrameOutput_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of FrameOutput.

type Frame_Slice

type Frame_Slice []Frame

Holds a slice of type Frame.

func (*Frame_Slice) Repeats

func (op *Frame_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of Frame.

func (*Frame_Slice) TypeInfo

func (*Frame_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of Frame.

type Notification

type Notification interface{}

type Notification_Slot

type Notification_Slot struct{ Value Notification }

Holds a single slot.

func (*Notification_Slot) TypeInfo

func (*Notification_Slot) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a single slot.

type Notification_Slots

type Notification_Slots []Notification

Holds a slice of slots.

func (*Notification_Slots) Repeats

func (op *Notification_Slots) Repeats() bool

Implements typeinfo.Repeats for a slice of slots.

func (*Notification_Slots) TypeInfo

func (*Notification_Slots) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of slots.

type PairChanged

type PairChanged struct {
	A      string
	B      string
	Rel    string
	Markup map[string]any
}

The relationship between two objects has changed. For instance, an object's whereabouts as indicated by a parent-child type relation.

func (*PairChanged) GetMarkup

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

Implements typeinfo.Markup

func (*PairChanged) TypeInfo

func (*PairChanged) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type PairChanged_Slice

type PairChanged_Slice []PairChanged

Holds a slice of type PairChanged.

func (*PairChanged_Slice) Repeats

func (op *PairChanged_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of PairChanged.

func (*PairChanged_Slice) TypeInfo

func (*PairChanged_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of PairChanged.

type SceneEnded

type SceneEnded struct {
	Domains []string
	Markup  map[string]any
}

One or more scenes ( aka domain ) have finished.

func (*SceneEnded) GetMarkup

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

Implements typeinfo.Markup

func (*SceneEnded) TypeInfo

func (*SceneEnded) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type SceneEnded_Slice

type SceneEnded_Slice []SceneEnded

Holds a slice of type SceneEnded.

func (*SceneEnded_Slice) Repeats

func (op *SceneEnded_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of SceneEnded.

func (*SceneEnded_Slice) TypeInfo

func (*SceneEnded_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of SceneEnded.

type SceneStarted

type SceneStarted struct {
	Domains []string
	Markup  map[string]any
}

One or more scenes ( aka domain ) have started.

func (*SceneStarted) GetMarkup

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

Implements typeinfo.Markup

func (*SceneStarted) TypeInfo

func (*SceneStarted) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type SceneStarted_Slice

type SceneStarted_Slice []SceneStarted

Holds a slice of type SceneStarted.

func (*SceneStarted_Slice) Repeats

func (op *SceneStarted_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of SceneStarted.

func (*SceneStarted_Slice) TypeInfo

func (*SceneStarted_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of SceneStarted.

type StateChanged

type StateChanged struct {
	Noun   string
	Aspect string
	Prev   string
	Trait  string
	Markup map[string]any
}

Some object in the game has changed from one state to another.

func (*StateChanged) GetMarkup

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

Implements typeinfo.Markup

func (*StateChanged) TypeInfo

func (*StateChanged) TypeInfo() typeinfo.T

Implements typeinfo.Instance

type StateChanged_Slice

type StateChanged_Slice []StateChanged

Holds a slice of type StateChanged.

func (*StateChanged_Slice) Repeats

func (op *StateChanged_Slice) Repeats() bool

Implements typeinfo.Repeats for a slice of StateChanged.

func (*StateChanged_Slice) TypeInfo

func (*StateChanged_Slice) TypeInfo() typeinfo.T

Implements typeinfo.Instance for a slice of StateChanged.