Added comments to FeragMessage and TitleEnd

This commit is contained in:
Oliver Jakoubek 2020-05-29 15:01:50 +02:00
commit 68cf7ef7db
2 changed files with 13 additions and 2 deletions

View file

@ -2,19 +2,23 @@ package feragstring
import "fmt"
// TitleEnd is the struct for the FERAG title info message (%2441)
type TitleEnd struct {
FeragMessage
titleName string
}
func (ti *TitleEnd) PrintObjectName() string {
// TitleName returns the title name segment (+40) FERAG-formatted
func (ti *TitleEnd) TitleName() string {
return fmt.Sprintf("+40%-8s", ti.titleName)
}
// SetTitleName sets the title name segment (+40)
func (ti *TitleEnd) SetTitleName(titleName string) {
ti.titleName = titleName
}
// NewTitleEnd returns a new TitleEnd struct
func NewTitleEnd() *TitleEnd {
t := TitleEnd{
FeragMessage: FeragMessage{
@ -25,8 +29,9 @@ func NewTitleEnd() *TitleEnd {
return &t
}
// Message returns the complete FERAG-formatted message for title end
func (ti *TitleEnd) Message() string {
message := ti.FeragMessage.MessageTemplate()
payload := fmt.Sprintf("+40%-8s", ti.titleName)
payload := ti.TitleName()
return message(&ti.FeragMessage, payload)
}