plugins

Documentation

Overview

Copyright 2024 bbaa

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• Variables
• type BackPlugin
  • func (bp *BackPlugin) DisplayName() string
  • func (bp *BackPlugin) Init(pm pluginabi.PluginManager) (err error)
  • func (bp *BackPlugin) Name() string
• type BackupPlugin
  • func (bp *BackupPlugin) Cancel(player string)
  • func (bp *BackupPlugin) CleanupBackup()
  • func (bp *BackupPlugin) CleanupPlayerdataBackup()
  • func (bp *BackupPlugin) Cli(player string, args ...string)
  • func (bp *BackupPlugin) Confirm(player string)
  • func (bp *BackupPlugin) Copy(src string, dst string) (err error)
  • func (bp *BackupPlugin) DisplayName() string
  • func (bp *BackupPlugin) Init(pm pluginabi.PluginManager) (err error)
  • func (bp *BackupPlugin) MakeBackup(comment string)
  • func (bp *BackupPlugin) MakePlayerDataBackup()
  • func (bp *BackupPlugin) Name() string
  • func (bp *BackupPlugin) Pause()
  • func (bp *BackupPlugin) Rollback(backup string)
  • func (bp *BackupPlugin) SaveSize(src string) (int64, error)
  • func (bp *BackupPlugin) Start()
• type BackupPlugin_RollbackPending
• type HomePlugin
  • func (hp *HomePlugin) DisplayName() string
  • func (hp *HomePlugin) Init(pm pluginabi.PluginManager) (err error)
  • func (hp *HomePlugin) Name() string
• type HomePlugin_HomeList
• type RollbackPlayerdataPending
  • func (rpp *RollbackPlayerdataPending) Abort(player string)
  • func (rpp *RollbackPlayerdataPending) Comfirm(player string)
  • func (rpp *RollbackPlayerdataPending) Execute()
  • func (rpp *RollbackPlayerdataPending) Start(caller *BackupPlugin)
• type RollbackWorldPending
  • func (rwp *RollbackWorldPending) Abort(player string)
  • func (rwp *RollbackWorldPending) Comfirm(player string)
  • func (rwp *RollbackWorldPending) Execute()
  • func (rwp *RollbackWorldPending) Start(caller *BackupPlugin)
• type StatusPlugin
  • func (s *StatusPlugin) DisplayName() string
  • func (s *StatusPlugin) Init(pm pluginabi.PluginManager) (err error)
  • func (s *StatusPlugin) Name() string
  • func (s *StatusPlugin) Pause()
  • func (s *StatusPlugin) Start()
• type StatusPlugin_MinecraftLoad
• type TeleportPlugin
  • func (tp *TeleportPlugin) DisplayName() string
  • func (tp *TeleportPlugin) Init(pm pluginabi.PluginManager) (err error)
  • func (tp *TeleportPlugin) Name() string

Constants

const BackupPlugin_PageSize = 5

Variables

var DeathEventBlackList = []*regexp.Regexp{regexp.MustCompile("has made the advancement")}

var DeathEventLog = regexp.MustCompile(`MinecraftServer.*\]: (\w+) [\w ]+$`)

var StatusPlugin_ParseLoad = regexp.MustCompile(`(?:Dim )?(.*?)[ ]?(?:\(.*?\))?: Mean tick time:.(.*?).ms.*?TPS:.(.{6})`)

Types

type BackPlugin

type BackPlugin struct {
	plugin.BasePlugin
}

func (*BackPlugin) DisplayName

func (bp *BackPlugin) DisplayName() string

func (*BackPlugin) Init

func (bp *BackPlugin) Init(pm pluginabi.PluginManager) (err error)

func (*BackPlugin) Name

func (bp *BackPlugin) Name() string

type BackupPlugin

type BackupPlugin struct {
	plugin.BasePlugin
	Source string // Minecraft world source dir
	Dest   string // backup dest
	// contains filtered or unexported fields
}

func (*BackupPlugin) Cancel

func (bp *BackupPlugin) Cancel(player string)

func (*BackupPlugin) CleanupBackup

func (bp *BackupPlugin) CleanupBackup()

func (*BackupPlugin) CleanupPlayerdataBackup

func (bp *BackupPlugin) CleanupPlayerdataBackup()

func (*BackupPlugin) Cli

func (bp *BackupPlugin) Cli(player string, args ...string)

func (*BackupPlugin) Confirm

func (bp *BackupPlugin) Confirm(player string)

func (*BackupPlugin) Copy

func (bp *BackupPlugin) Copy(src string, dst string) (err error)

func (*BackupPlugin) DisplayName

func (bp *BackupPlugin) DisplayName() string

func (*BackupPlugin) Init

func (bp *BackupPlugin) Init(pm pluginabi.PluginManager) (err error)

func (*BackupPlugin) MakeBackup

func (bp *BackupPlugin) MakeBackup(comment string)

func (*BackupPlugin) MakePlayerDataBackup

func (bp *BackupPlugin) MakePlayerDataBackup()

func (*BackupPlugin) Name

func (bp *BackupPlugin) Name() string

func (*BackupPlugin) Pause

func (bp *BackupPlugin) Pause()

func (*BackupPlugin) Rollback

func (bp *BackupPlugin) Rollback(backup string)

func (*BackupPlugin) SaveSize

func (bp *BackupPlugin) SaveSize(src string) (int64, error)

func (*BackupPlugin) Start

func (bp *BackupPlugin) Start()

type BackupPlugin_RollbackPending

type BackupPlugin_RollbackPending interface {
	Comfirm(player string)
	Abort(player string)
	Start(caller *BackupPlugin)
}

type HomePlugin

type HomePlugin struct {
	plugin.BasePlugin
}

func (*HomePlugin) DisplayName

func (hp *HomePlugin) DisplayName() string

func (*HomePlugin) Init

func (hp *HomePlugin) Init(pm pluginabi.PluginManager) (err error)

func (*HomePlugin) Name

func (hp *HomePlugin) Name() string

type HomePlugin_HomeList

type HomePlugin_HomeList map[string]*plugin.MinecraftPosition

type RollbackPlayerdataPending

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

func (*RollbackPlayerdataPending) Abort

func (rpp *RollbackPlayerdataPending) Abort(player string)

func (*RollbackPlayerdataPending) Comfirm

func (rpp *RollbackPlayerdataPending) Comfirm(player string)

func (*RollbackPlayerdataPending) Execute

func (rpp *RollbackPlayerdataPending) Execute()

func (*RollbackPlayerdataPending) Start

func (rpp *RollbackPlayerdataPending) Start(caller *BackupPlugin)

type RollbackWorldPending

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

func (*RollbackWorldPending) Abort

func (rwp *RollbackWorldPending) Abort(player string)

func (*RollbackWorldPending) Comfirm

func (rwp *RollbackWorldPending) Comfirm(player string)

func (*RollbackWorldPending) Execute

func (rwp *RollbackWorldPending) Execute()

func (*RollbackWorldPending) Start

func (rwp *RollbackWorldPending) Start(caller *BackupPlugin)

type StatusPlugin

type StatusPlugin struct {
	plugin.BasePlugin

	LastBroadcastMspt float64
	LastMspt          []float64
	ForgeTpsCommand   string
	// contains filtered or unexported fields
}

func (*StatusPlugin) DisplayName

func (s *StatusPlugin) DisplayName() string

func (*StatusPlugin) Init

func (s *StatusPlugin) Init(pm pluginabi.PluginManager) (err error)

func (*StatusPlugin) Name

func (s *StatusPlugin) Name() string

func (*StatusPlugin) Pause

func (s *StatusPlugin) Pause()

func (*StatusPlugin) Start

func (s *StatusPlugin) Start()

type StatusPlugin_MinecraftLoad

type StatusPlugin_MinecraftLoad struct {
	World string
	MSPT  float64
	TPS   float64
	// contains filtered or unexported fields
}

type TeleportPlugin

type TeleportPlugin struct {
	plugin.BasePlugin
}

func (*TeleportPlugin) DisplayName

func (tp *TeleportPlugin) DisplayName() string

func (*TeleportPlugin) Init

func (tp *TeleportPlugin) Init(pm pluginabi.PluginManager) (err error)

func (*TeleportPlugin) Name

func (tp *TeleportPlugin) Name() string