Modding Events

Events

Events is a JSON template.

It seems to keep the data for in-game events, along with different story branches, and also effects of choice done through the events.

In the template are the following data values: {|
 * DATA NAME
 * DATA TYPE
 * NOTES
 * UNUSED
 * ChildBranches
 * Branch(?)
 * Seems to be all diverging stories from this point
 * ParentBranch
 * Branch(?)
 * The branch that brought the current event to this point.
 * QualitiesAffected
 * Quality(?)
 * The qualities that are affected by this particular event. (And possible how they are affected, I.e adding and removing)
 * QualitiesRequired
 * Quality(?)
 * The qualities that are required to choose this particular event. (And possibly the number required, both in min/max)
 * Image
 * String
 * The name for the image shown. All images can be found in the Images folder
 * Description
 * String
 * The text that is shown when this event happens.
 * Tag
 * String
 * Probably just a set of Tags that make it easier to find events
 * ExoticEffect
 * Array - Effect
 * Not sure yet
 * Note
 * String
 * Most likely simply a note between the developers. It's possible that this also contains typical "Choosing this will..." text.
 * ChallengeLevel
 * Integer
 * Not sure yet
 * UnclearedEditAt
 * String
 * Not sure yet
 * LastEditedBy
 * String
 * The person who last edited this. Most likely used when collaborating on stories.
 * Ordering
 * Integer or Float
 * Guessing this means in what order this particular choice is displayed among all orders
 * ShowAsMessage
 * Boolean
 * Not sure yet
 * LivingStory
 * Story(?)
 * Not sure yet
 * LinkToEvent
 * Event
 * Not sure yet. Seems to be a means of letting individual events attach together. Need more investigating
 * Deck
 * Deck(?)
 * Deck seems to relate to UI like buttons and the likes. Not sure how exactly
 * Category
 * String
 * Not sure how this work, but I'm guessing it's connected to the game engine somehow.
 * LimitedToArea
 * Area(?)
 * I'm guessing this makes an event only happen at some areas, be this Unterzee-coordinates or particular islands
 * World
 * World(?)
 * Not sure yet
 * Transient
 * Boolean
 * Not sure yet
 * Stickiness
 * Integer
 * Not sure yet
 * MoveToAreaId
 * Integer
 * I'm guessing this lets the player move to a particular area given by Id
 * MoveToArea
 * Area(?)
 * Same as MoveToAreaId, but instead the Area itself (or a string) is given
 * MoveToDomicile
 * String? Domicile?
 * Not sure, but guessing this lets you teleport the ship somehow different from Area. Needs investigation.
 * SwitchToSetting
 * Setting(?)
 * Not sure yet
 * FatePointsChange
 * Integer
 * Seems to be an artifact if this was the format used in FallenLondon. Not sure if it's used in Sunless Sea
 * BootyValue
 * Integer
 * Not sure
 * LoginJournalAgainstQuality
 * Unknown
 * Not sure
 * Setting
 * Setting(?)
 * Not sure
 * Urgency
 * String
 * Seems to control if the player can choose to go through with a certain event, or if they can backtrack with "On second thought, maybe not" choice
 * Teaser
 * String
 * This text is posted somewhere. Possible the somewhat grey text under the main text
 * OwnerName
 * String
 * Possibly the creator of the original event
 * -DateTimeCreated
 * DateTime
 * The date and the time this event was created (updated?)
 * Distribution
 * Integer
 * Not sure yet
 * Autofire
 * Boolean
 * Not sure. Maybe to say that this event can just suddenly pop out without any user interaction beforehand.
 * CanGoBack
 * Boolean
 * Not sure how this relates to Urgency, but it is likely that this disables the "Go back" button aswell.
 * Name
 * String
 * The name of the event/story
 * Id
 * Integer
 * Unique name for the event
 * Setting
 * Setting(?)
 * Not sure
 * Urgency
 * String
 * Seems to control if the player can choose to go through with a certain event, or if they can backtrack with "On second thought, maybe not" choice
 * Teaser
 * String
 * This text is posted somewhere. Possible the somewhat grey text under the main text
 * OwnerName
 * String
 * Possibly the creator of the original event
 * -DateTimeCreated
 * DateTime
 * The date and the time this event was created (updated?)
 * Distribution
 * Integer
 * Not sure yet
 * Autofire
 * Boolean
 * Not sure. Maybe to say that this event can just suddenly pop out without any user interaction beforehand.
 * CanGoBack
 * Boolean
 * Not sure how this relates to Urgency, but it is likely that this disables the "Go back" button aswell.
 * Name
 * String
 * The name of the event/story
 * Id
 * Integer
 * Unique name for the event
 * Name
 * String
 * The name of the event/story
 * Id
 * Integer
 * Unique name for the event
 * Integer
 * Unique name for the event