Cut Scene Creator

[Ego13]

Cut Scene Creator v1.1​

This script was designed to play short and simple "Cut Scenes" using seperate pictures. It does not support gifs!
Feel free to share in what project you used it and what for (not neccessary, but I'm curios).

Report any bugs you may find and leave suggestions for further improvement!

Terms of use

• You may modify the script
• Give credits
• You may not distribute it yourself!
• You may not claim this as your own!

What this script can do

• Play animations that consist of a sperate image for every frame
• Animation can be smaller and/or transparent graphics as well
• Automatically centers smaller graphics
• Show text in the animation screen
• Make sure the animation screen can't be closed until the animation played at least once
• Loop an animation, play it once or multiple finite amount of times
• Manipulate the framerate (default is 40)
• Play sounds during cut scenes

How to install

1. Download the .txt file with the code here
2. Open your game project
3. Create a a new script section above Main and call it "CutSceneCreator"
4. Copy the code from the .txt file and paste it in the new script section
5. Add a new folder in the Graphics folder and call it Animator, all graphic files go here
6. Copy and paste a default background image in the Animator folder and name it "animbg", it should be 512x384 pixels

How to set up the Cut Scene Files

Spoiler:

1. The image file names have to include a word/name, this has to be the Cut Scene Name (f.e. banette)
2. Each Cut Scene File need to contain a number starting with 1 and NO extra 0 (f.e. banette1, banette2,...), each number represents the frame number, the order is important!
3. Place all files in Graphics/Animator/ (Note: The Animator folder is not there by default, so you will have to create it)

How to use

Spoiler:

• Option 1: Simple Cut Scene, no sound, no text, loopable
  insert the following line in your event and replace the parameters
  simpleAnimation(filename,frames,loop,framerate)
  Example: simpleAnimation("banette",57,true,30)
  
  
• Option 2: Simple Cut Scene, no sound, with text, loopable
  insert the following line in your event and replace the parameters
  textAnimation(filename,frames,loop,framerate,message1,message2,message3)
  Example: textAnimation("banette",57,true,30,"This is message one!","This is the second message?",nil)
  
  
• Option 3:Cut Scene, with sound, with text, repeats X amount of times
  insert the following line in your event and replace the parameters
  soundAnimation(filename,frames,framerate,amount,message1,soundfile,soundframe,samount)
  Example: soundAnimation("banette",57,30,2,"This is message one!","cry354",20,1)
  
  
• Option 4: Simple Cut Scene, no sound, no text, repeats X amount of times
  insert the following line in your event and replace the parameters
  simpleAnimationRepeat(filename,frames,framerate,amount)
  Example: simpleAnimationRepeat("banette",57,30,2)

Explanation for the parameters

Spoiler:

• filename: is the word or anmiation name that appears in your file (f.e. "banette")
• frames: the total amount of frames your animation has
• loop: put in true if you want the animation to loop and false if it should play only once
• framerate: the desired framerate the animation should play at, the fewer frames you have the lower the framerate should be, default framerate is 40
• message1/message2/message3: type in the message you want to appear make sure to put in " (f.e. "This is a test text!") if there is no second or third message be sure to put in nil
• amount: the amount of times the animation should be repeated
• soundfile: the filename of the sound effect in Audio/SE, without file extentsion (f.e. "Battle flee")
• soundframe: the frame number the sound should start playing
• samount: the amount of times the sound effect should be played, use this to avoid dual playing on short cut scenes, put in 0 to disable sound

Notes

Spoiler:

• As soon as the message appears, the animation will stop
• The animation will play at least once before the text messages can appear
• Make sure that you have a background file in the Animator folder and name it "animbg"
• If your animations are smaller than everything else (like sprites), it will automatically be centred
• Capitalization matters for the filenames
• When the script command in the event get too long pay attention to where it is split or use extendtext

Examples by deepseadoggo

Spoiler:

Use as a pre-battle scene
"image removed"

Use as a transport scene
View attachment 83665

Use as a starter cut scene
View attachment 83600

Credits
[USER]Ego13[/USER] for coding
[USER]deepseadoggo[/USER] for the initial idea, testing and examples