StorySequence

struct StorySequence

Struct containing a dictionary of StorySequence.Step . Also describes StorySequence.Step and StorySequence.Event .

Author

Cadence Holmes 2018
  • Undocumented

    Declaration

    Swift

    var steps: Dictionary<Int, Step>
  • Undocumented

    Declaration

    Swift

    var music: String?
  • Struct containing music files for StorySequences.

    Add new music media files to this collection as necessary.

    ** Any changes to this struct need to be reflected in the PowerUp Story Designer web app.

    See more

    Declaration

    Swift

    struct Sounds
  • Struct containing descriptions of each character and the different types of images available.

    As new scenes are added, this static data should be updated. Each character should be represented as a descriptive constant, and should reference a tuple describing the images and referencing their file name.

    ** Image files for StorySequencePlayer should be in the following format: CharacterName^Version

    The carot ^ is necessary for StorySequencePlayer. The first half (CharacterName) must be the same for all images of the same character. The second half (Version) should be descriptive, such as mood.

    ** Any changes to this struct need to be reflected in the PowerUp Story Designer web app.

    See more

    Declaration

    Swift

    struct Images
  • These are the possible positions for an image. StorySequencePlayer interprets these cases per left and right.

    Near describes the image being close to the edge of the screen, and far describes the image being close to the middle of the screen. Mid is the middle of those positions.

    ** This enum typically won’t need to change or be updated, but if any are made, make sure to also reflect those changes in the PowerUp Story Designer web app.

    See more

    Declaration

    Swift

    enum ImagePosition : String
  • These are the possible animations for StorySequenceEvents. As new animations are created and added in StorySequencePlayer.swift and Animate.swift, this collection should be updated.

    ** Any changes to this struct need to be reflected in the PowerUp Story Designer web app.

    See more

    Declaration

    Swift

    enum ImageAnimation : String
  • Struct containing two StorySequence.Event representing the left and right sides of the StorySequencePlayer .

    See more

    Declaration

    Swift

    struct Step
  • Struct describing a single event with text, image, image position, and image animation type.

    See more

    Declaration

    Swift

    struct Event
  • Undocumented

    Declaration

    Swift

    init(music: String?, _ steps: Dictionary<Int, Step>)