ogd.games.PENGUINS.features package

Subpackages

ogd.games.PENGUINS.features.bases namespace
- Submodules
- ogd.games.PENGUINS.features.bases.PerRegionFeature module
  - PerRegionFeature
    - PerRegionFeature.MinVersion()

Submodules

ogd.games.PENGUINS.features.ActivityCompleted module

class ogd.games.PENGUINS.features.ActivityCompleted.ActivityCompleted(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.

ogd.games.PENGUINS.features.ActivityDuration module

class ogd.games.PENGUINS.features.ActivityDuration.ActivityDuration(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.

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.PENGUINS.features.BuiltNestCount module

class ogd.games.PENGUINS.features.BuiltNestCount.BuiltNestCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.BuiltWrongNestCount module

class ogd.games.PENGUINS.features.BuiltWrongNestCount.BuiltWrongNestCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.EatFishCount module

class ogd.games.PENGUINS.features.EatFishCount.EatFishCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.EggLostCount module

class ogd.games.PENGUINS.features.EggLostCount.EggLostCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.EggRecoverTime module

class ogd.games.PENGUINS.features.EggRecoverTime.EggRecoverTime(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.GazeCount module

class ogd.games.PENGUINS.features.GazeCount.GazeCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.GazeDuration module

class ogd.games.PENGUINS.features.GazeDuration.GazeDuration(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.

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.PENGUINS.features.LogVersion module

class ogd.games.PENGUINS.features.LogVersion.LogVersion(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]

ogd.games.PENGUINS.features.MirrorWaddleDuration module

class ogd.games.PENGUINS.features.MirrorWaddleDuration.MirrorWaddleDuration(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.PenguinInteractCount module

class ogd.games.PENGUINS.features.PenguinInteractCount.PenguinInteractCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.PlayerInactiveAvgDuration module

class ogd.games.PENGUINS.features.PlayerInactiveAvgDuration.PlayerInactiveAvgDuration(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.RegionDuration module

class ogd.games.PENGUINS.features.RegionDuration.RegionDuration(params: GeneratorParameters, region_map: List[Dict[str, Any]])[source]

Bases: PerRegionFeature

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

List of ExtractionMode supported by the Extractor

Base function to give a list of which ExtractionModes an extractor will handle. :return: _description_ :rtype: List[ExtractionMode]

ogd.games.PENGUINS.features.RegionEnterCount module

class ogd.games.PENGUINS.features.RegionEnterCount.RegionEnterCount(params: GeneratorParameters, region_map: List[Dict[str, Any]])[source]: Bases: PerCountFeature

ogd.games.PENGUINS.features.RegionsEncountered module

class ogd.games.PENGUINS.features.RegionsEncountered.RegionsEncountered(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.RingChimesCount module

class ogd.games.PENGUINS.features.RingChimesCount.RingChimesCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.RockBashCount module

class ogd.games.PENGUINS.features.RockBashCount.RockBashCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.RockMultiplePickupCount module

class ogd.games.PENGUINS.features.RockMultiplePickupCount.RockMultiplePickupCount(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.

ogd.games.PENGUINS.features.RockPickupCount module

class ogd.games.PENGUINS.features.RockPickupCount.RockPickupCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.SessionDuration module

class ogd.games.PENGUINS.features.SessionDuration.SessionDuration(params: GeneratorParameters, session_id: str)[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]

ogd.games.PENGUINS.features.SkuaBashCount module

class ogd.games.PENGUINS.features.SkuaBashCount.SkuaBashCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.SkuaPeckCount module

class ogd.games.PENGUINS.features.SkuaPeckCount.SkuaPeckCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.SnowBallDuration module

class ogd.games.PENGUINS.features.SnowBallDuration.SnowBallDuration(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.WaddleCount module

class ogd.games.PENGUINS.features.WaddleCount.WaddleCount(params: GeneratorParameters)[source]: Bases: SessionFeature

ogd.games.PENGUINS.features.WaddlePerRegion module

class ogd.games.PENGUINS.features.WaddlePerRegion.WaddlePerRegion(params: GeneratorParameters, region_map: List[Dict[str, Any]])[source]: Bases: PerRegionFeature

Module contents

Initializer for Penguins features