SourceMod::ITextListener_SMC Class Reference

Describes the events available for reading an SMC stream. More...

#include <public/ITextParsers.h>

Public Member Functions
virtual unsigned int	GetTextParserVersion2 ()
	Returns version number.
virtual void	ReadSMC_ParseStart ()
	Called when starting parsing.
virtual void	ReadSMC_ParseEnd (bool halted, bool failed)
	Called when ending parsing. More...
virtual SMCResult	ReadSMC_NewSection (const SMCStates *states, const char *name)
	Called when entering a new section. More...
virtual SMCResult	ReadSMC_KeyValue (const SMCStates *states, const char *key, const char *value)
	Called when encountering a key/value pair in a section. More...
virtual SMCResult	ReadSMC_LeavingSection (const SMCStates *states)
	Called when leaving the current section. More...
virtual SMCResult	ReadSMC_RawLine (const SMCStates *states, const char *line)
	Called after an input line has been preprocessed. More...

Detailed Description

Describes the events available for reading an SMC stream.

Member Function Documentation

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_KeyValue ( const SMCStates *  states, const char *  key, const char *  value  )

inlinevirtual

Called when encountering a key/value pair in a section.

Parameters

states	Parsing states.
key	Key string.
value	Value string. If no quotes were specified, this will be NULL, and key will contain the entire string.

Returns

SMCResult directive.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_LeavingSection ( const SMCStates *  states )

inlinevirtual

Called when leaving the current section.

Parameters

states

Parsing states.

Returns

SMCResult directive.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_NewSection ( const SMCStates *  states, const char *  name  )

inlinevirtual

Called when entering a new section.

Parameters

states	Parsing states.
name	Name of section, with the colon omitted.

Returns

SMCResult directive.

virtual void SourceMod::ITextListener_SMC::ReadSMC_ParseEnd ( bool  halted, bool  failed  )

inlinevirtual

Called when ending parsing.

Parameters

halted	True if abnormally halted, false otherwise.
failed	True if parsing failed, false otherwise.

virtual SMCResult SourceMod::ITextListener_SMC::ReadSMC_RawLine ( const SMCStates *  states, const char *  line  )

inlinevirtual

Called after an input line has been preprocessed.

Parameters

states	Parsing states.
line	Contents of the line, null terminated at the position of the newline character (thus, no newline will exist).

Returns

SMCResult directive.

---

The documentation for this class was generated from the following file:

• public/ITextParsers.h