Documentation ¶
Overview ¶
Package demoinfocs provides a demo parser for the game Counter-Strike: Global Offensive. It is based on the official demoinfogo tool by Valve as well as Stats Helix's demoinfo. A good entry point to using the library is the Parser type. Demo events are documented in the events package.
Index ¶
- Variables
- type EventEmitter
- type GameState
- type NetMessageCreator
- type Parser
- func (p *Parser) Cancel()
- func (p *Parser) CurrentFrame() int
- func (p *Parser) CurrentTime() float32
- func (p *Parser) GameState() *GameState
- func (p *Parser) Header() common.DemoHeader
- func (p *Parser) ParseHeader() (common.DemoHeader, error)
- func (p *Parser) ParseNextFrame() (b bool, err error)
- func (p *Parser) ParseToEnd() (err error)
- func (p *Parser) Progress() float32
- func (p *Parser) RegisterEventHandler(handler interface{}) dp.HandlerIdentifier
- func (p *Parser) RegisterNetMessageHandler(handler interface{}) dp.HandlerIdentifier
- func (p *Parser) SendTableParser() *st.SendTableParser
- func (p *Parser) UnregisterEventHandler(identifier dp.HandlerIdentifier)
- func (p *Parser) UnregisterNetMessageHandler(identifier dp.HandlerIdentifier)
- type ParserConfig
- type TeamState
Constants ¶
This section is empty.
Variables ¶
var ( // ErrCancelled signals that parsing was cancelled via Parser.Cancel() ErrCancelled = errors.New("Parsing was cancelled before it finished (ErrCancelled)") // ErrUnexpectedEndOfDemo signals that the demo is incomplete / corrupt - // these demos may still be useful, check the how far the parser got. ErrUnexpectedEndOfDemo = errors.New("Demo stream ended unexpectedly (ErrUnexpectedEndOfDemo)") // ErrInvalidFileType signals that the input isn't a valid CS:GO demo. ErrInvalidFileType = errors.New("Invalid File-Type; expecting HL2DEMO in the first 8 bytes") )
Parsing errors
var DefaultParserConfig = ParserConfig{
MsgQueueBufferSize: -1,
}
DefaultParserConfig is the default Parser configuration used by NewParser(). You may set this variable to a custom configuration to be used by NewParser().
Functions ¶
This section is empty.
Types ¶
type EventEmitter ¶ added in v0.5.0
type EventEmitter interface {
Register(parser *Parser, eventDispatcher func(event interface{}))
}
EventEmitter is the interface to define additional event-emitters. The emitters may fire additional events by calling the eventDispatcher function received during registration of the emitter. See also: package fuzzy for existing emitters with fuzzy-logic that depends on the demo-type.
type GameState ¶ added in v0.4.0
type GameState struct {
// contains filtered or unexported fields
}
GameState contains all game-state relevant information.
func (*GameState) CTState ¶ added in v0.4.0
CTState returns the TeamState of the CT team. Make sure you handle swapping sides properly if you keep the reference.
func (GameState) IngameTick ¶ added in v0.4.0
IngameTick returns the latest actual tick number of the server during the game. Watch out, I've seen this return wonky negative numbers at the start of demos.
func (GameState) Participants ¶ added in v0.4.0
Participants returns all connected players. This includes spectators.
func (GameState) PlayingParticipants ¶ added in v0.4.0
PlayingParticipants returns all players that aren't spectating or unassigned.
type NetMessageCreator ¶ added in v0.5.0
NetMessageCreator creates additional net-messages to be dispatched to net-message handlers. See also: ParserConfig.AdditionalNetMessageCreators & Parser.RegisterNetMessageHandler()
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
Parser can parse a CS:GO demo. Creating a Parser is done via NewParser(). To start off use Parser.ParseHeader() to parse the demo header. After parsing the header Parser.ParseNextFrame() and Parser.ParseToEnd() can be used to parse the demo. Use Parser.RegisterEventHandler() to receive notifications about events.
func NewParser ¶
NewParser creates a new Parser with the default configuration. The demostream io.Reader (e.g. os.File or bytes.Reader) must provide demo data in the '.DEM' format. See also: NewCustomParser() & DefaultParserConfig
func NewParserWithConfig ¶ added in v0.5.0
func NewParserWithConfig(demostream io.Reader, config ParserConfig) *Parser
NewParserWithConfig returns a new Parser with a custom configuration. See also: NewParser() & ParserConfig
func (*Parser) Cancel ¶
func (p *Parser) Cancel()
Cancel aborts ParseToEnd(). All information that was already read up to this point will still be used (and new events may still be sent).
func (*Parser) CurrentFrame ¶
CurrentFrame return the number of the current frame, aka. 'demo-tick' (Since demos often have a different tick-rate than the game). Starts with frame 0, should go up to DemoHeader.PlaybackFrames but might not be the case (usually it's just close to it).
func (*Parser) CurrentTime ¶
CurrentTime returns the ingame time in seconds since the start of the demo.
func (*Parser) Header ¶ added in v0.2.0
func (p *Parser) Header() common.DemoHeader
Header returns the DemoHeader which contains the demo's metadata.
func (*Parser) ParseHeader ¶
func (p *Parser) ParseHeader() (common.DemoHeader, error)
ParseHeader attempts to parse the header of the demo. Returns error if the filestamp (first 8 bytes) doesn't match HL2DEMO.
func (*Parser) ParseNextFrame ¶
ParseNextFrame attempts to parse the next frame / demo-tick (not ingame tick). Returns true unless the demo command 'stop' or an error was encountered. May return ErrUnexpectedEndOfDemo for incomplete / corrupt demos. Panics if header hasn't been parsed yet - see Parser.ParseHeader().
func (*Parser) ParseToEnd ¶
ParseToEnd attempts to parse the demo until the end. Aborts and returns ErrCancelled if Cancel() is called before the end. May return ErrUnexpectedEndOfDemo for incomplete / corrupt demos. May panic if the demo is corrupt in some way.
func (*Parser) Progress ¶
Progress returns the parsing progress from 0 to 1. Where 0 means nothing has been parsed yet and 1 means the demo has been parsed to the end. Might not actually be reliable since it's just based on the reported tick count of the header.
func (*Parser) RegisterEventHandler ¶
func (p *Parser) RegisterEventHandler(handler interface{}) dp.HandlerIdentifier
RegisterEventHandler registers a handler for game events. Must be of type func(<EventType>) where EventType is the kind of event that is handled. To catch all events func(interface{}) can be used. Parameter handler has to be of type interface{} because lolnogenerics. Returns a identifier with which the handler can be removed via UnregisterEventHandler().
func (*Parser) RegisterNetMessageHandler ¶ added in v0.5.0
func (p *Parser) RegisterNetMessageHandler(handler interface{}) dp.HandlerIdentifier
RegisterNetMessageHandler registers a handler for net-messages. Must be of type func(*<EventType>) where EventType is the kind of event that is handled. To catch all events func(interface{}) can be used. Parameter handler has to be of type interface{} because lolnogenerics. Returns a identifier with which the handler can be removed via UnregisterNetMessageHandler(). This is a beta feature and may be changed or replaced without notice.
func (*Parser) SendTableParser ¶ added in v0.4.0
func (p *Parser) SendTableParser() *st.SendTableParser
SendTableParser returns the sendtable parser. This is a beta feature and may be changed or replaced without notice.
func (*Parser) UnregisterEventHandler ¶ added in v0.4.0
func (p *Parser) UnregisterEventHandler(identifier dp.HandlerIdentifier)
UnregisterEventHandler removes a game event handler via identifier. The identifier is returned at registration by RegisterEventHandler().
func (*Parser) UnregisterNetMessageHandler ¶ added in v0.5.0
func (p *Parser) UnregisterNetMessageHandler(identifier dp.HandlerIdentifier)
UnregisterNetMessageHandler removes a net-message handler via identifier. The identifier is returned at registration by RegisterNetMessageHandler().
type ParserConfig ¶ added in v0.5.0
type ParserConfig struct { // MsgQueueBufferSize defines the size of the internal net-message queue. // For large demos, fast i/o and slow CPUs higher numbers are suggested and vice versa. // The buffer size can easily be in the hundred-thousands to low millions for the best performance. // A negative value will make the Parser automatically decide the buffer size during ParseHeader() // based on the number of ticks in the demo (nubmer of ticks = buffer size); // this is the default behavior for DefaultParserConfig. // Zero enforces sequential parsing. MsgQueueBufferSize int // AdditionalNetMessageCreators maps net-message-IDs to creators (instantiators). // The creators should return a new instance of the correct protobuf-message type (from the msg package). // Interesting net-message-IDs can easily be discovered with the build-tag 'debugdemoinfocs'; when looking for 'UnhandledMessage'. // Check out demopacket.go to see which net-messages are already being parsed by default. // This is a beta feature and may be changed or replaced without notice. AdditionalNetMessageCreators map[int]NetMessageCreator // AdditionalEventEmitters contains additional event emitters - either from the fuzzy package or custom ones. // This is mainly used to add logic specifically for one type of demo (e.g. Matchmaking, FaceIt etc.). // This is a beta feature and may be changed or replaced without notice. // See also: package fuzzy for existing emitters with fuzzy-logic that depends on the demo-type. AdditionalEventEmitters []EventEmitter }
ParserConfig contains the configuration for creating a new Parser.
type TeamState ¶
type TeamState struct {
// contains filtered or unexported fields
}
TeamState contains a team's ID, score, clan name & country flag.
func (TeamState) Flag ¶
Flag returns the team's country flag. Watch out, in some demos this is upper-case and in some lower-case.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package bitread provides a wrapper for github.com/markus-wa/gobitread with CS:GO demo parsing specific helpers.
|
Package bitread provides a wrapper for github.com/markus-wa/gobitread with CS:GO demo parsing specific helpers. |
Package common contains common types, constants and functions used over different demoinfocs packages.
|
Package common contains common types, constants and functions used over different demoinfocs packages. |
Package events contains all events that can be sent out from demoinfocs.Parser.
|
Package events contains all events that can be sent out from demoinfocs.Parser. |
Package msg is a generated protocol buffer package.
|
Package msg is a generated protocol buffer package. |
Package sendtables contains sendtable specific magic and should really be better documented (TODO).
|
Package sendtables contains sendtable specific magic and should really be better documented (TODO). |