document base game defaults for slides

This commit is contained in:
JohnCorby 2023-11-28 13:11:04 -08:00
parent 47dcd79744
commit 67ff544fb3

View File

@ -7,80 +7,75 @@ namespace NewHorizons.External.Modules.Props.EchoesOfTheEye
public class SlideInfo public class SlideInfo
{ {
/// <summary> /// <summary>
/// Ambient light colour when viewing this slide. /// The path to the image file for this slide.
/// </summary> /// </summary>
public MColor ambientLightColor; public string imagePath;
// SlideAmbientLightModule // SlideAmbientLightModule
/// <summary> /// <summary>
/// Ambient light intensity when viewing this slide. /// Ambient light intensity when viewing this slide. (Base game default: 1)
/// </summary> /// </summary>
public float ambientLightIntensity; public float ambientLightIntensity;
/// <summary> /// <summary>
/// Ambient light range when viewing this slide. /// Ambient light range when viewing this slide. (Base game default: 20)
/// </summary> /// </summary>
public float ambientLightRange; public float ambientLightRange;
/// <summary>
/// Ambient light colour when viewing this slide. (Base game default: white)
/// </summary>
public MColor ambientLightColor;
/// <summary>
/// Spotlight intensity modifier when viewing this slide. (Base game default: 0)
/// </summary>
public float spotIntensityMod;
// SlideBackdropAudioModule // SlideBackdropAudioModule
/// <summary> /// <summary>
/// The name of the AudioClip that will continuously play while watching these slides /// The name of the AudioClip that will continuously play while watching these slides (Base game default: Reel_1_Backdrop_A)
/// </summary> /// </summary>
public string backdropAudio; public string backdropAudio;
/// <summary> /// <summary>
/// The time to fade into the backdrop audio /// The time to fade into the backdrop audio (Base game default: 2)
/// </summary> /// </summary>
public float backdropFadeTime; public float backdropFadeTime;
// SlideBeatAudioModule // SlideBeatAudioModule
/// <summary> /// <summary>
/// The name of the AudioClip for a one-shot sound when opening the slide. /// The name of the AudioClip for a one-shot sound when opening the slide. (Base game default: Reel_1_Beat_A)
/// </summary> /// </summary>
public string beatAudio; public string beatAudio;
/// <summary> /// <summary>
/// The time delay until the one-shot audio /// The time delay until the one-shot audio (Base game default: 0)
/// </summary> /// </summary>
public float beatDelay; public float beatDelay;
// SlideBlackFrameModule // SlideBlackFrameModule
/// <summary> /// <summary>
/// Before viewing this slide, there will be a black frame for this many seconds. /// Before viewing this slide, there will be a black frame for this many seconds. (Base game default: 0)
/// </summary> /// </summary>
public float blackFrameDuration; public float blackFrameDuration;
/// <summary>
/// The path to the image file for this slide.
/// </summary>
public string imagePath;
// SlidePlayTimeModule // SlidePlayTimeModule
/// <summary> /// <summary>
/// Play-time duration for auto-projector slides. /// Play-time duration for auto-projector slides. (Base game default: 0)
/// </summary> /// </summary>
public float playTimeDuration; public float playTimeDuration;
// SlideShipLogEntryModule // SlideShipLogEntryModule
/// <summary> /// <summary>
/// Ship log fact revealed when viewing this slide /// Ship log fact revealed when viewing this slide (Base game default: "")
/// </summary> /// </summary>
public string reveal; public string reveal;
/// <summary>
/// Spotlight intensity modifier when viewing this slide.
/// </summary>
public float spotIntensityMod;
} }
} }