event.go

// Copyright (c) 2022, The Emergent Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package looper

import (
	"strconv"
)

// A Event has function(s) that can be called at a particular point
// in the loop, when the counter is AtCounter value.
type Event struct {

	// Name of this event.
	Name string

	// AtCounter is the counter value upon which this Event occurs.
	AtCounter int

	// OnEvent are the functions to run when Counter == AtCounter.
	OnEvent NamedFuncs
}

// String describes the Event in human readable text.
func (event *Event) String() string {
	s := event.Name + ": "
	s = s + "[at " + strconv.Itoa(event.AtCounter) + "] "
	if len(event.OnEvent) > 0 {
		s = s + "Events: " + event.OnEvent.String()
	}
	return s
}

// NewEvent returns a new event with given name, function, at given counter
func NewEvent(name string, atCtr int, fun func()) *Event {
	ev := &Event{Name: name, AtCounter: atCtr}
	ev.OnEvent.Add(name, fun)
	return ev
}