ogd.games.JOURNALISM.features package

Submodules

ogd.games.JOURNALISM.features.AttributeView module

class ogd.games.JOURNALISM.features.AttributeView.AttributeView(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.ChoiceClickCount module

class ogd.games.JOURNALISM.features.ChoiceClickCount.ChoiceClickCount(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.ContinuesOnFail module

class ogd.games.JOURNALISM.features.ContinuesOnFail.ContinuesOnFail(params: GeneratorParameters)[source]

Bases: SessionFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.EditorNoteOpen module

class ogd.games.JOURNALISM.features.EditorNoteOpen.EditorNoteOpen(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.FailureAttributes module

class ogd.games.JOURNALISM.features.FailureAttributes.FailureAttributes(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Per-level feature to generate a list of failures, where each failure in the list is the set of player attributes

Parameters:: PerLevelFeature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

ogd.games.JOURNALISM.features.FailureCount module

class ogd.games.JOURNALISM.features.FailureCount.FailureCount(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.FinalAttributes module

class ogd.games.JOURNALISM.features.FinalAttributes.FinalAttributes(params: GeneratorParameters)[source]

Bases: PerLevelFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

ogd.games.JOURNALISM.features.GameComplete module

class ogd.games.JOURNALISM.features.GameComplete.GameComplete(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.LevelCompleteCount module

class ogd.games.JOURNALISM.features.LevelCompleteCount.LevelCompleteCount(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.LevelCompleted module

class ogd.games.JOURNALISM.features.LevelCompleted.LevelCompleted(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.LevelTime module

class ogd.games.JOURNALISM.features.LevelTime.LevelTime(params: GeneratorParameters)[source]

Bases: PerLevelFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.MaxedPlayerAttribute module

class ogd.games.JOURNALISM.features.MaxedPlayerAttribute.MaxedPlayerAttribute(params: GeneratorParameters)[source]

Bases: PerCountFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.MeanSnippetTime module

class ogd.games.JOURNALISM.features.MeanSnippetTime.MeanSnippetTime(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.PlayTime module

class ogd.games.JOURNALISM.features.PlayTime.PlayTime(params: GeneratorParameters, threshold: int)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

IDLE_TIME_THRESHOLD: Final[timedelta] = datetime.timedelta(seconds=60)[source]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

static defaultThreshold()[source]

ogd.games.JOURNALISM.features.PlayerAttributes module

class ogd.games.JOURNALISM.features.PlayerAttributes.PlayerAttributes(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.QuitLevel module

class ogd.games.JOURNALISM.features.QuitLevel.QuitLevel(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.QuitNode module

class ogd.games.JOURNALISM.features.QuitNode.QuitNode(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.QuitType module

class ogd.games.JOURNALISM.features.QuitType.QuitType(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.QuitTypePerLevel module

class ogd.games.JOURNALISM.features.QuitTypePerLevel.QuitTypePerLevel(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.SessionPlayTime module

class ogd.games.JOURNALISM.features.SessionPlayTime.SessionPlayTime(params: GeneratorParameters, threshold: int)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

IDLE_TIME_THRESHOLD: Final[timedelta] = datetime.timedelta(seconds=60)[source]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

static defaultThreshold()[source]

ogd.games.JOURNALISM.features.SkillSequenceCount module

class ogd.games.JOURNALISM.features.SkillSequenceCount.SkillSequenceCount(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.SnippetReceivedCount module

class ogd.games.JOURNALISM.features.SnippetReceivedCount.SnippetReceivedCount(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.SnippetReplace module

class ogd.games.JOURNALISM.features.SnippetReplace.SnippetReplace(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.SnippetsCollected module

class ogd.games.JOURNALISM.features.SnippetsCollected.SnippetsCollected(params: GeneratorParameters)[source]

Bases: PerLevelFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.SnippetsSubmitted module

class ogd.games.JOURNALISM.features.SnippetsSubmitted.SnippetsSubmitted(params: GeneratorParameters)[source]

Bases: PerLevelFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

has_printed = False[source]

ogd.games.JOURNALISM.features.StoryAlignment module

class ogd.games.JOURNALISM.features.StoryAlignment.StoryAlignment(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.StoryAlignmentSequence module

class ogd.games.JOURNALISM.features.StoryAlignmentSequence.StoryAlignmentSequence(params: GeneratorParameters)[source]

Bases: PerLevelFeature

classmethod AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.StoryCompleteTime module

class ogd.games.JOURNALISM.features.StoryCompleteTime.StoryCompleteTime(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.StoryEditorTime module

class ogd.games.JOURNALISM.features.StoryEditorTime.StoryEditorTime(params: GeneratorParameters, threshold: int)[source]

Bases: PerLevelFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

IDLE_TIME_THRESHOLD: Final[timedelta] = datetime.timedelta(seconds=60)[source]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

static defaultThreshold()[source]

ogd.games.JOURNALISM.features.StoryScore module

class ogd.games.JOURNALISM.features.StoryScore.StoryScore(params: GeneratorParameters)[source]

Bases: PerLevelFeature

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.StoryScoreSequence module

class ogd.games.JOURNALISM.features.StoryScoreSequence.StoryScoreSequence(params: GeneratorParameters)[source]

Bases: PerLevelFeature

classmethod AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.TextClickCount module

class ogd.games.JOURNALISM.features.TextClickCount.TextClickCount(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.TopAttribute module

class ogd.games.JOURNALISM.features.TopAttribute.TopAttribute(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.TopPlayerAttribute module

class ogd.games.JOURNALISM.features.TopPlayerAttribute.TopPlayerAttribute(params: GeneratorParameters)[source]

Bases: PerCountFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.TopPlayerQuitType module

class ogd.games.JOURNALISM.features.TopPlayerQuitType.TopPlayerQuitType(params: GeneratorParameters)[source]

Bases: PerCountFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.TotalFails module

class ogd.games.JOURNALISM.features.TotalFails.TotalFails(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.TotalLevelTime module

class ogd.games.JOURNALISM.features.TotalLevelTime.TotalLevelTime(params: GeneratorParameters)[source]: Bases: PerLevelFeature

ogd.games.JOURNALISM.features.UserPlayTime module

class ogd.games.JOURNALISM.features.UserPlayTime.UserPlayTime(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.WorstAttribute module

class ogd.games.JOURNALISM.features.WorstAttribute.WorstAttribute(params: GeneratorParameters)[source]

Bases: SessionFeature

Template file to serve as a guide for creating custom Feature subclasses for games.

Parameters:: Feature (_type_) – Base class for a Custom Feature class.

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

ogd.games.JOURNALISM.features.WorstPlayerAttribute module

class ogd.games.JOURNALISM.features.WorstPlayerAttribute.WorstPlayerAttribute(params: GeneratorParameters)[source]

Bases: PerCountFeature

static AvailableModes() → List[ExtractionMode][source]

List of ExtractionMode supported by the Feature.

Overridden from Extractor’s version of the function, only makes the Feature-related modes supported. :return: _description_ :rtype: List[ExtractionMode]

Subfeatures() → List[str][source]

Base function to get a list of names of the sub-feature(s) a given Feature class outputs. By default, a Feature class has no subfeatures. However, if a Feature class is written to output multiple values, it will need to override this function to return an appropriate list. Note, Subfeatures must match the ordering from the override of GetFeatureNames, if returning a list of length > 0.

Returns:: A list of names of subfeatures for the Feature sub-class.
Return type:: Tuple[str]

Module contents

Initializer for Journalism features