sgc7plugin

Documentation

Index

• Variables
• type BasicPlugin
  • func NewBasicPlugin() *BasicPlugin
  • func (bp *BasicPlugin) Init()
  • func (bp *BasicPlugin) Random(ctx context.Context, r int) (int, error)
• type FastPlugin
  • func NewFastPlugin() *FastPlugin
  • func (fp *FastPlugin) Init()
  • func (fp *FastPlugin) Random(ctx context.Context, r int) (int, error)
• type FuncNewPlugin
• type IPlugin
• type PluginBase
  • func NewPluginBase() PluginBase
  • func (bp *PluginBase) AddRngUsed(ri *sgc7utils.RngInfo)
  • func (bp *PluginBase) ClearCache()
  • func (bp *PluginBase) ClearUsedRngs()
  • func (bp *PluginBase) GetScenePool() any
  • func (bp *PluginBase) GetUsedRngs() []*sgc7utils.RngInfo
  • func (bp *PluginBase) RollbackUsedRngs() error
  • func (bp *PluginBase) SetCache(arr []int)
  • func (bp *PluginBase) SetScenePool(pool any)
  • func (bp *PluginBase) TagUsedRngs()
• type PluginsMgr
  • func NewPluginsMgr(funcNewPlugin FuncNewPlugin) *PluginsMgr
  • func (mgr *PluginsMgr) FreePlugin(plugin IPlugin)
  • func (mgr *PluginsMgr) NewPlugin() IPlugin

Variables

var (
	// ErrInvalidTag - invalid tag
	ErrInvalidTag = errors.New("invalid tag")
)

var IsNoRNGCache bool

Types

type BasicPlugin

type BasicPlugin struct {
	PluginBase
}

BasicPlugin - basic plugin

func NewBasicPlugin

func NewBasicPlugin() *BasicPlugin

NewBasicPlugin - new a BasicPlugin

func (*BasicPlugin) Init

func (bp *BasicPlugin) Init()

Init - initial

func (*BasicPlugin) Random

func (bp *BasicPlugin) Random(ctx context.Context, r int) (int, error)

Random - return [0, r)

type FastPlugin

type FastPlugin struct {
	PluginBase
	RNG *fastrand.RNG
}

BasicPlugin - basic plugin

func NewFastPlugin

func NewFastPlugin() *FastPlugin

NewBasicPlugin - new a BasicPlugin

func (*FastPlugin) Init

func (fp *FastPlugin) Init()

Init - initial

func (*FastPlugin) Random

func (fp *FastPlugin) Random(ctx context.Context, r int) (int, error)

Random - return [0, r)

type FuncNewPlugin

type FuncNewPlugin func() IPlugin

FuncNewPlugin - new a IPlugin

type IPlugin

type IPlugin interface {
	// Random - return [0, r)
	Random(ctx context.Context, r int) (int, error)
	// GetUsedRngs - get used rngs
	GetUsedRngs() []*sgc7utils.RngInfo
	// ClearUsedRngs - clear used rngs
	ClearUsedRngs()
	// TagUsedRngs - new a tag for current UsedRngs
	TagUsedRngs()
	// RollbackUsedRngs - rollback UsedRngs with the latest tag
	RollbackUsedRngs() error
	// SetCache - set cache
	SetCache(arr []int)
	// ClearCache - clear cached rngs
	ClearCache()
	// Init - initial
	Init()
	// SetScenePool - set scene pool
	SetScenePool(any)
	// GetScenePool - get scene pool
	GetScenePool() any
}

IPlugin - plugin

type PluginBase

type PluginBase struct {
	RngUsed   []*sgc7utils.RngInfo
	Cache     []int
	Tag       int
	ScenePool any
}

PluginBase - base

func NewPluginBase

func NewPluginBase() PluginBase

func (*PluginBase) AddRngUsed

func (bp *PluginBase) AddRngUsed(ri *sgc7utils.RngInfo)

AddRngUsed - added used rngs

func (*PluginBase) ClearCache

func (bp *PluginBase) ClearCache()

ClearCache - clear cached rngs

func (*PluginBase) ClearUsedRngs

func (bp *PluginBase) ClearUsedRngs()

ClearUsedRngs - clear used rngs

func (*PluginBase) GetScenePool

func (bp *PluginBase) GetScenePool() any

GetScenePool - get scene pool

func (*PluginBase) GetUsedRngs

func (bp *PluginBase) GetUsedRngs() []*sgc7utils.RngInfo

GetUsedRngs - get used rngs

func (*PluginBase) RollbackUsedRngs

func (bp *PluginBase) RollbackUsedRngs() error

RollbackUsedRngs - rollback UsedRngs with a tag

func (*PluginBase) SetCache

func (bp *PluginBase) SetCache(arr []int)

SetCache - set cache

func (*PluginBase) SetScenePool

func (bp *PluginBase) SetScenePool(pool any)

SetScenePool - set scene pool

func (*PluginBase) TagUsedRngs

func (bp *PluginBase) TagUsedRngs()

TagUsedRngs - new a tag for current UsedRngs

type PluginsMgr

type PluginsMgr struct {
	// contains filtered or unexported fields
}

PluginsMgr - plugins manager

func NewPluginsMgr

func NewPluginsMgr(funcNewPlugin FuncNewPlugin) *PluginsMgr

NewPluginsMgr - new a PluginsMgr

func (*PluginsMgr) FreePlugin

func (mgr *PluginsMgr) FreePlugin(plugin IPlugin)

FreePlugin - free a Plugin

func (*PluginsMgr) NewPlugin

func (mgr *PluginsMgr) NewPlugin() IPlugin

NewPlugin - new a Plugin