Skip to content

Remove references to overloadable shot profiles #428

@nullbuilds

Description

@nullbuilds

Section 18.5 of the tutorial mentions the profile of a shot can be overloaded in a higher priority mode; however, attempting to do so results in an assertion AssertionError: Device <shot.shot_right_inlane> cannot be overloaded..

Based on a groups discussion from 2020 and a commit from 2017, it appears as though overloading shot profiles was removed some time back. If this is true, the docs should be updated to remove references to this feature or replace them with the recommended alternative to avoid confusion.

Skimming through the doc site, I found the following references:

  • Section 18.5 of the tutorial
    • The first code snippet doesn't actually appear to be overloading anything but rather creating an entirely new shot with the mode name in it; however, the paragraph and snippets below it do mention overloading the profile.
  • The mode2 config file in the shots examples
    • Includes a mode2_shot_changing_profile shot that appears to be intended as an example of overloading profiles as it only includes the profile property.
    • There are also two profiles named changing_profile_one and changing_profile_two that appear to only be used for overloading
  • The block property of shot_profiles
    • Not certain if the block property serves any purpose without the ability to overload shots profiles in modes but I could be misunderstanding its purpose
  • The Shots config reference

I'm only just learning MPF so please let me know if I've misunderstood and this functionality is still supported.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions