MODULE: TypedText 1.0.0

[Crimson Wizard]

DOWNLOAD TypedText 1.0.0 MODULE PACK
Archive contains modules: TypedText, TypedTextHelper and TypedTextDrawing.
DOWNLOAD Demo Game

Additionally, latest sources of both the script module and the demo game may be found in this repository:
https://github.com/ivan-mogilko/ags-script-modules

Module supports AGS 3.2.1 and higher


Introduction

TypedText module provides means for displaying continiously typed text, also known as typewriter style display. Letter appears by letter with certain delay in between.

A while ago I was scripting a typing text animation for a game project; later I found out that there is already Phemar's Typewriter module, but it did not allow the kind of behavior that the project required, so I continued with my own script.
Now I found some free time to rewrite that script in a cleaner way and make an actual script module of it. But I also copied few things from Phemar's module, to make TypedText suitable for the needs of people who used Phemar's module before.

The general peculiarity of this module, and also what makes it different from existing one, is that it is based on a Type (struct), and objects of that type, instead of a Function. This leads to following effects:
1. You can have multiple typed text animations simultaneously.
2. Since objects keep their states in them, you may have both blocking and non-blocking typed texts.
3. Having an object with exposed interface (public functions and properties) make it possible to alter its behavior on fly, as well as override it, and use it to create your own custom typewriters.


Using an object may be more complicated than using a single function, and require time to study it, so I added TypedTextHelper module with number of "helper" functions to make it easier to start using TypedText in your project. Also those functions may be just what you need if standart behavior is enough. This is why I will explain their use before going into detail about TypedText itself.

But first I need to quickly clarify on some concepts.


TypedText concepts

TypedText simulates continious text typing, letter by letter. When doing so it passes several states:

Inactive - this is when it has no text set whatsoever.
Typing text - this is when it is in process of typing text.
Waiting for reader - this is when all text was fully typed and displayed on screen, but settings demand TypedText to wait a little longer to give human an opportunity to finish reading the text.
Idling - this is when typing and waiting is complete, and TypedText is not going to do anything else.

NOTE: Helper functions, such as those that display TypedText on Overlays, rely on "waiting for reader" state to know when typed text should be removed from screen.

TypedText has a concept of the flashing caret. Depending on setup, it may flash last typed letter, or draw certain symbol behind typed text (like '_', for example).
The caret, if enabled, commences to flash whenever delay between two typed letters is greater than caret's waiting timer. This timer resets when next letter is typed. This also means that when all  the text was already typed, caret will then flash endlessly (so long as TypedText is on screen).

Keeping the above in mind, TypedText relies on following parameters:

Typing delay - how many game ticks to wait after each typed letter.
Typing delay style - this concept is copied from Phemar's module, and defines delay behavior for spaces and caret-returns in the text (are they same, slower than usual or faster than usual),
Caret depiction - is the caret is depicted anyway, and how: this may be flashing last letter, or specific string drawn in the end, or even a sprite - for the advanced TypedText implementations.
Caret flash times - how long caret stays on screen and stays hidden when it flashes.
Text reading time - how much time, in game ticks, is spent on reading 1 letter: this parameter is used to calculate average reading time of a text.

Finally, extended variants of TypedText also support sound that is played whenever next letter was typed.


Using TypedTextHelper

TypedTextHelper module requires TypedText module to present above it in the modules list.

It provides a number of functions to run typed text blocking or non-blocking, in a number of ways: on a Button, on a Label, or on an Overlay.

Because TypedText has a significant number of parameters, many of which are supposed to stay same for the most of the time in game, I thought it would be very inconvenient to put all of those parameters into functions. Instead, TypedTextHelper has a special preset system.
This works pretty simple actually: you setup least changing properties as a preset under certain ID, and then use that preset ID when starting typed text on Label, or Overlay; this makes all of that preset's parameters to be used for that instance of text typing.

Following are preset functions you may use:

Code: ags

/// Set general parameters for the specified preset
TypewriterPreset.SetGeneral(int preset, int delay_min, int delay_max, TypedDelayStyle style, int read_time = 12);
/// Set caret parameters for the specified preset
TypewriterPreset.SetCaret(int preset, int flash_on_time, int flash_off_time, TypedCaretStyle style, String caret_str, int caret_sprite = 0);
/// Set sound parameters for the specified preset
TypewriterPreset.SetSounds(int preset, AudioClip *type_sound, AudioClip *caret_sound, AudioClip *end_sound);
TypewriterPreset.SetSoundArray(int preset, AudioClip *type_sounds[], int type_sound_count,
                                AudioClip *caret_sound, AudioClip *end_sound);

Maximal number of presets is determined with TYPEDTEXTHELPER_MAXPRESETS constant in the module header. It is 8 by default, but you may increase it if you need more.
Maximal number of sounds that you may assign for preset and each typewriter is determined with TYPEDTEXTRENDER_MAXSOUNDS contant.

Best place to set preset's parameters is "game_start" function, but you may change them anytime by using same preset ID.

After you set up at least one preset, you may begin using helper functions. All of them are made as extender functions, which means you first type object (Button, Label, Character) pointer name, then call the function from it, like:

Code: ags

// NOTE: preset is optional, and will be 0 if you don't type anything
/// Print TypedText as a text on button
SomeButton.Typewriter(String text, BlockingStyle bs, int preset = 0);
/// Print TypedText as a text on label
SomeLabel.Typewriter(String text, BlockingStyle bs, int preset = 0);

The only difference is Overlay static extender (static extenders is a new thing since AGS 3.4.0), where you do not use overlay's pointer, but just "Overlay" word:

Code: ags

// NOTE: preset is optional, and will be 0 if you don't type anything
/// Print TypedText as a text on created overlay
Overlay.Typewriter(int x, int y, int color, FontType font, String text, BlockingStyle bs, int preset = 0);

If you are working in pre-3.4.0, you will have to use non-extender function for overlays, called TypewriteOnOverlay, but it works essentially same, and has same parameters (except it is not called from Overlay).


If you run these functions with eBlock, they will display typed text inside of them, and return when typing (and waiting) state has finished.
If you run them with eNoBlock, they will return back immediately, but typed text will work on a background, updated from repeatedly_execute inside the module.

You may run only one blocking typed text at the same time.
Maximal simultaneous non-blocking typed texts is determined by TYPEDTEXTHELPER_MAXTYPEWRITERS constant in the module header. It is 8 by default, but you may increase it if you need more.


Each of those helper functions return unique ID of typewriter. If you want to control that typewriter, such as detect when it stops typing, or be able to cancel it, store this ID in a variable for later. You may then use this ID with TypewriterRunners static functions and properties:

Code: ags

/// Get number of currently running typewriters
int TypewriterRunners.ActiveCount;
/// Get number of maximal supported typewriters that can run simultaneously
int TypewriterRunners.MaxCount;
/// Get whether given typewriter ID is currently running (use unique ID as an array index)
bool TypewriterRunners.IsActive[];
/// Get whether given typewriter ID is blocking (use unique ID as an array index)
bool TypewriterRunners.IsBlocking[];
/// Stop typewriter under given ID
void Cancel(int id);

The principal example:

Code: ags

int tw_id = SomeButton.Typewriter(text, eNoBlock);

<... later ...>

if (TypewriterRunners.IsActive[tw_id])
  TypewriterRunners.Cancel(tw_id); // interrupt typewriter if it was still running

Using TypedText directly

If above helper functions do not do what you like, you may create and use objects of TypedText struct, or any derived structs, directly.

TypedText struct's purpose is to calculate timing and  basic state of the text. It does not draw anything on screen on its own, but calculates and tells how the text should look like at any given moment, letting you to use that information as you see fit. In other words, it tells what is happening, but does not tell you how it should look (and sound) like.


Setting up TypedText is fairly straighforward, here are its configuration properties:

Code: ags

/// Base delay (in ticks) between every typing event
import attribute int              TypeDelay;
/// Bounds for random base delay
import attribute int              TypeDelayMin;
import attribute int              TypeDelayMax;
import attribute TypedDelayStyle  TypeDelayStyle;
/// Time (in ticks) the caret stays shown
import attribute int              CaretFlashOnTime;
/// Time (in ticks) the caret stays hidden
import attribute int              CaretFlashOffTime;
/// Time (in ticks) given to read one text character
import attribute int              TextReadTime;


/// Whitespace/caret-return delay style defines relation of special case
/// delays to the base type delay.
/// Idea is conforming to the Phemar's Typewriter module.
enum TypedDelayStyle
{
  /// wait for the same amount of time as after regular letters
  eTypedDelay_Uniform = 0,
  /// wait twice as long after whitespaces
  eTypedDelay_LongSpace,
  /// wait twice as less after whitespaces
  eTypedDelay_ShortSpace,
  /// randomly choose a style every time
  eTypedDelay_Mixed
};

And its control methods are:

Code: ags

  
/// Gets/sets paused state
import attribute bool            Paused;

/// Clears all text and resets all timers
import void                      Clear();
/// Sets new string, resets all timers and commences typing
import void                      Start(String text);
/// Skips all the remaining typing
import void                      Skip();

/// Update typed text state, advancing it by single tick
import void                      Tick();

Since you are using TypedText yourself, you need to be continiously checking its state in repeating function:

Code: ags

/// Full string that has to be typed
readonly import attribute String  FullString;
/// Part of string that is supposed to be shown at current time
readonly import attribute String  CurrentString;
/// Part of string that was 'typed' during latest update
readonly import attribute String  LastTyped;

/// Tells whether TypedText has active content to process or display
readonly import attribute bool    IsActive;
/// Tells whether TypedText is in process of typing text
/// (return FALSE if either no text is set, or text is already fully typed)
readonly import attribute bool    IsTextBeingTyped;
/// Tells whether TypedText is waiting for the text to be read by player
/// (return FALSE when reading timer has ran out, regardless of other states)
readonly import attribute bool    IsWaitingForReader;
/// Tells whether TypedText is currently idling, either not having a content,
/// or after finishing all the required actions (typing & waiting for reader)
readonly import attribute bool    IsIdle;
/// Tells whether caret should be currently displayed
readonly import attribute bool    IsCaretShown;

/// Gets if the new character was just typed
readonly import attribute bool    EvtCharTyped;
/// Gets if the text has just ended being typed
readonly import attribute bool    EvtFinishedTyping;

One of the simpliest examples for using TypedText is this:

Code: ags

// in GlobalScript.asc
TypedText my_tt;

function game_start()
{
    // Config typed text to your liking
    my_tt.TypeDelay = 4;
    my_tt.CaretFlashOnTime = 4;
    my_tt.CaretFlashOffTime = 4;
}

// Calling TypeSay will start typed text
function TypeSay(string s)
{
    my_tt.Start(s);
}

function repeatedly_execute()
{
    if (my_tt.IsIdle)
    {
        my_tt.Clear(); // clear the text, stop timers ticking, etc
    }
    else if (my_tt.IsActive)
    {
        my_tt.Tick(); // update TT
        String text_to_show = my_tt.CurrentString;
        if (my_tt.IsCaretShown)
            text_to_show = text_to_show.Append("_"); // append caret symbol to the end of the text
        player.SayBackground(text_to_show); // print TT's current text as a player's background speech
    }
}

Using TypewriterRender and its subtypes

There is a number of extended types provided by the module, which add bit more functionality. First is struct TypewriterRender, which extends TypedText, and other structs extend TypewriterRender further.

As was mentioned above, TypedText does not draw anything on its own, only calculates the text's state. TypewriterRender does not do much too, but it adds few more properties and serves rather like a base class for actual visualizing:

Code: ags

/// Caret display style
import attribute TypedCaretStyle CaretStyle;
/// A string (or single character) that represents typewriter caret
import attribute String          CaretString;

/// The only sound to play when a character is typed
import attribute AudioClip *    TypeSound;
/// Array of sounds to choose at random when a character is typed
readonly import attribute AudioClip *TypeSounds[];
/// Number of typing sounds registered
readonly import attribute int    TypeSoundCount;
/// Sound to play when the line break is met
import attribute AudioClip *    CaretSound;
/// Sound to play when the typewriter finished typing text
import attribute AudioClip *    EndSound;

/// Sets the array of sounds to play at random when character is typed
import void                      SetRandomTypeSounds(AudioClip *sounds[], int count);


/// Style of the caret displayed during typing
enum TypedCaretStyle
{
  /// No caret display
  eTypedCaret_None = 0, 
  /// Flash last character
  eTypedCaret_LastChar, 
  /// Draw separate caret at the next assumed character location
  eTypedCaret_Explicit
};

The actual workers are inheriting types: TypewriterButton, TypewriterLabel, TypewriterOverlay. They have respective properties to set up an object they will print text on (or from which perspective), as well as their own overwritten Clear, Start and Tick methods.

Using them you will avoid necessity to draw text yourself:

Code: ags

// in GlobalScript.asc
TypewriterLabel my_tt_label;

function game_start()
{
    my_tt_label.TypeOnLabel = lblTypewriter; // put your actual label's name here
    my_tt_label.TypeDelay = 4;
    my_tt_label.CaretFlashOnTime = 4;
    my_tt_label.CaretFlashOffTime = 4;
    my_tt_label.CaretStyle = eTypedCaret_LastChar; // make last char flash
    my_tt_label.TypeSound = aTypewriterTyping; // set sound to play
}

// Calling TypeOnLabel will start typed text
function TypeOnLabel(string s)
{
    my_tt_label.Start(s);
}

function repeatedly_execute()
{
    if (my_tt_label.IsIdle)
        my_tt_label.Clear(); // remove text when done typing & waiting for the reader
    else if (my_tt_label.IsActive)
        my_tt_label.Tick(); // update text
    // notice that you do not need to point where to print the text anymore,
    // TypewriterLabel already knows that and does printing for you
}

Using TypedTextDrawing

TypedTextDrawing is an advanced struct, extending TypewriterRender, that lets you draw typed text on DrawingSurface. This means you may have typewriter text on literally anything that can give drawing surfaces or have assigned image: room and GUI backgrounds, objects, character frames even (crazy).
Besides, TypedTextDrawing is the only one of the provided types that can draw caret as a sprite.

TypedTextDrawing is located in its own separate module (of same name) and requires TypedText module to work (but not TypedTextHelper).

Setting TypedTextDrawing up is very similar to setting other TypedText subtypes, but you also need to set up its position on DrawingSurface, text color and font, and optionally background color.

What is more important to remember, you must explicitly call Draw function, because you need to pass DrawingSurface pointer to its drawing. It cannot store DrawingSurface once for use later, because that goes against rules of using drawing surfaces (they have to be released right after every use).

Here is some example, that draws typed text on a room's backround

Code: ags

// in GlobalScript.asc
TypedTextDrawing tt_draw;
DynamicSprite *roomBkg; // will keep saved room background

function game_start()
{
    tt_draw.TypeDelay = 4;
    tt_draw.CaretFlashOnTime = 4;
    tt_draw.CaretFlashOffTime = 4;
    tt_draw.CaretStyle = eTypedCaret_Explicit; // draw caret
    tt_draw.CaretSprite = 1010; // put your sprite number here
    tt_draw.TypeSound = aTypewriterTyping; // set sound to play
    
    tt_draw.X = 40;
    tt_draw.Y = 40;
    tt_draw.Width = Room.Width - 80;
    tt_draw.Height = Room.Height - 80;
    tt_draw.Font = eFontText;
    tt_draw.TextAlign = eAlignCentre;
}

function RestoreRoomBkg()
{
    // Restore original room background
    DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
    ds.DrawImage(0, 0, roomBkg.Graphic);
    ds.Release();
}

// Calling TypeOnDS will start typed text
function TypeOnDS(string s)
{
    if (roomBkg == null)
    {
        roomBkg = DynamicSprite.CreateFromBackground();
    }
    else
    {
        RestoreRoomBkg();
    }
    tt_draw.Start(s);
}

function repeatedly_execute()
{
    if (tt_draw.IsIdle)
    {
        tt_draw.Clear();
        RestoreRoomBkg();
    }
    else if (tt_draw.IsActive)
    {
        tt_draw.Tick(); // update TT
        DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
        tt_draw.Draw(ds);
        ds.Release();
    }
}

[Cassiebsg]

Uhm... you give me weird ideas with the module.
Thanks a bunch for the hard work! Sure will try it, if I need the functionality of a typewriter.

[Crimson Wizard]

Next beta version: 0.6.5
Download: https://bitbucket.org/ivan-mogilko/ags-script-modules/downloads/TypedText_0.6.5.zip
A little demo-game (compiled files only for now) just to quickly demonstrate how this thing works: https://bitbucket.org/ivan-mogilko/ags-script-modules/downloads/TypedTextDemo%200.6.5.zip


What has changed since 0.6.0:

1. Most importantly, I realized that there is no way to know when typing animation finished if you run non-blocking helper. So I added whole new static struct to the TypedTextHelper module:

Code: ags

#define NO_TYPEWRITER 0

struct TypewriterRunners
{
  /// Get number of currently running typewriters
  readonly import static attribute int  ActiveCount;
  /// Get number of maximal supported typewriters that can run simultaneously
  readonly import static attribute int  MaxCount;
  /// Get whether given typewriter ID is currently running
  readonly import static attribute bool IsActive[];
  /// Get whether given typewriter ID is blocking
  readonly import static attribute bool IsBlocking[];
  
  /// Stop typewriter under given ID
  import static void Cancel(int id);
};

To put it simply, each Typewriter helper function (like Button.Typewriter, Overlay.Typewrite, etc) now returns unique typewriter ID, that then can be used to retrieve information, or interrupt typing, like this:

Code: ags

int tw_id = SomeButton.Typewriter(text, eNoBlock);

<...later...>

if (TypewriterRunners.IsActive[tw_id])
  TypewriterRunners.Cancel(tw_id);

2. Made modules compatible with AGS 3.2.1, in case people still using that version. (I know some still use 2.72, but I do not feel like going there)
Before AGS 3.4.0 you need to use "TypewriteOnOverlay" instead of "Overlay.Typewriter".

3. Renamed helper extenders from TypewriterPrint to just Typewriter, so they are now Button.Typewriter, and so on.

[Crimson Wizard]

Next beta version: 0.7.0
Download: https://bitbucket.org/ivan-mogilko/ags-script-modules/downloads/TypedText_0.7.0.zip
Finally a Demo Game with proper source: https://bitbucket.org/ivan-mogilko/ags-script-demos/downloads/TypedTextDemo_0.7.0.zip


What has changed since 0.6.5:

1. First of all, I completely removed TypewriterSpeech class and related helper function. It did not do anything very useful anyway at this point.
When it comes to speech there is a lot of things that need to be taken care about (animation, voice-over, etc), and I feel that currently TypedText module is at such stage where the priority is to make its basic intended behavior to work well.
It is still very much possible to create speech using TypewriterOverlay class; in fact the example of such speech (combined with Phylactere's module bubble) is featured in the Demo Game.

2. I fixed (hopefully) an issue that caused some words to begin appear at one line and then suddenly jump to another. This was related to difference in how TypedText and built-in AGS classes I print text to manage their contents. Fixing this problem allowed me to correctly detect when the new line starts, which helped in implementing CaretSound (see below).

3. More sound options are available now for TypewriterRender and all its descendants (TypewriterButton, *Label and *Overlay).
- Instead of having only one sound for typing, you can now supply your typewriter with an array of audio clips to choose at random when every next letter gets typed. Since I am supporting pre-3.4.0 versions of AGS, which did not allow dynamic arrays in structs, the TYPEDTEXTRENDER_MAXSOUNDS macro is defining how many typing sounds max each typewriter may have. You may increase or decrease this value if you wish. An array of clips is added using SetRandomTypeSounds function.
- CaretSound property lets you define a sound to play when typing starts at the next line (or rather when previous line ended?).
- EndSound property lets you define a sound to play when text finished typing.

4. Fixes in TypedTextDrawing:
- Some properties were missing their implementation.
- There were few mistakes related to wrapped lines alignment.


Make sure to check the DemoGame out, and click on everything you see there (not much, but fun, I hope) .
Personally, I think the module works pretty solid now. There are couple of more things I'd like to add in the future, but that may not be too soon.

[Cassiebsg]

Okay, this seems way more complex to use than I initially thought it would...
I'm trying to do something very simple, which is basically type the text non-blocking while some other blocking speech is running... but I'm basically drawing a blank... In other words, nothing is being typed, while the rest of my code runs perfectly, once it ends and shows the menu GUI, I get a square white box that will type my text, letter by letter, every time I click my mouse... twice.
Not exactly what I had in mind.

Thought it would be easier to work with, like add the settings to the start of the script, and then used TypedText(text) to show the lines...

[Crimson Wizard]

I'm trying to do something very simple, which is basically type the text non-blocking while some other blocking speech is running...

Hmm... doing something non-blocking while blocking speech is running, is probably not possible, because these typewriters are updated in repeatedly_execute.

Try opening TypedTextHelper.asc and changing "repeatedly_execute" function to "repeatedly_execute_always", and see if that works for you.

I guess I need to add an option for either running these typewriters in "always" or normal repeating function.

[Cassiebsg]

Managed to get it to display on the room now, but the text doesn't get typed unless I press the mouse button or the enter key. Plus, there's still a white box displaying, instead of the background.

Maybe you can figure out what I'm doing wrong here? I removed the code for the BG video and speech for now.
EDIT: I put the code in Room 1, since it's the only room that I'll be using for all the text. Not sure if that makes a difference or not.

Code: ags

// text script for room
TypedTextDrawing tt_draw;
DynamicSprite *roomBkg; // will keep saved room background
 
function game_start()
{
    tt_draw.TypeDelay = 4;
    tt_draw.CaretFlashOnTime = 4;
    tt_draw.CaretFlashOffTime = 4;
    tt_draw.CaretStyle = eTypedCaret_Explicit; // draw caret
    tt_draw.CaretSprite = 1010; // put your sprite number here
    //tt_draw.TypeSound = aTypewriterTyping; // set sound to play
    
    tt_draw.X = 40;
    tt_draw.Y = 40;
    tt_draw.Width = Room.Width - 80;
    tt_draw.Height = Room.Height - 80;
    tt_draw.Font = eFontGalactican;
    tt_draw.TextAlign = eAlignCentre;
}
 
function RestoreRoomBkg()
{
    // Restore original room background
    DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
    ds.DrawImage(0, 0, roomBkg.Graphic);
    ds.Release();
}
 
// Calling TypeOnDS will start typed text
function TypeOnDS(string st)
{
    if (roomBkg == null)
    {
        roomBkg = DynamicSprite.CreateFromBackground();
    }
    else
    {
        RestoreRoomBkg();
    }
    tt_draw.Start(st);
}
 
D3D_Video* video;
TypedText my_text;
     
function repeatedly_execute_always() 
{   
    if (tt_draw.IsActive)
    {
        tt_draw.Tick(); // update TT
        if (tt_draw.IsIdle)
        {
            tt_draw.Clear();
            RestoreRoomBkg();
        }
        else
        {
            DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
            tt_draw.Draw(ds);
            ds.Release();
        }
    }
	if (my_text.IsActive)
	{
		my_text.Tick(); // update TypedText
		if (my_text.IsIdle)
		{
			my_text.Clear(); // clear the text
		}
		else
		{
			String text_to_show=my_text.CurrentString;
			if (my_text.IsCaretShown)
			{
				text_to_show=text_to_show.Append("_"); // append carret symbol to the end of the text
			}
			DisplayAt(140, 113, 500, text_to_show); // print typedText's current text 
		}
	}
}
 
function room_Load() 
{
	// Config typed text
	my_text.TypeDelay=4;
	my_text.CaretFlashOnTime=4;
	my_text.CaretFlashOffTime=4;
	// End config of type text
	
	/*	SetViewport(0, 0);
		cShuttle.Transparency=100;
		cShuttle.Baseline=288;
		cShuttle.ChangeRoom(1, 199, 139);
	*/
}

function TypeSay(String st)
{
	my_text.Start(st);
}



void Cutscene_Intro()
{	

	 TypeSay("An AGS game by Sandra T. Almeida");
}


function room_AfterFadeIn()
{
	if (Game.DoOnceOnly("Play Intro")) Cutscene_Intro();
}

PS - I changed the sting from s to st, as the s was giving me a parse error.

[Crimson Wizard]

You are calling DisplayAt from repeatedly_execute_always, and it blocks your game completely until you press key or click mouse.

What are your intentions for typed text? TypedText class is not really meant for simple cases, it is for more complex cases when you need a custom behavior.

[Cassiebsg]

oh, right, forgot that display blocks. I put displayAt so I got possition the text, but now that I'm looking at the code, I think I spot where I should change that.

Let me so try with sayBG, brb.

EDIT: Okay, that worked. Well, almost, since for some reason didn't used my font nor it printed the last letter.
Also, why is the text scrolling to the left? I wanted it to start at one position and write to the right.

EDIT: Seems to be completely ignoring the settings at game start (I realize it game start wasn't doing anything in the room, and moved it to room_load) but seems to still be ignoring it.

[Crimson Wizard]

EDIT: Okay, that worked. Well, almost, since for some reason didn't used my font nor it printed the last letter.
Also, why is the text scrolling to the left? I wanted it to start at one position and write to the right.

You have "tt_draw.TextAlign = eAlignCentre;" probably you need eAlignLeft.
Not sure about the font...


EDIT:
Oh and about the last letter, I think there is a mistake in my example, the update code should be something like:

Code: ags

    if (tt_draw.IsIdle)
    {
        tt_draw.Clear();
        RestoreRoomBkg();
    }
    else if (tt_draw.IsActive)
    {
        tt_draw.Tick(); // update TT
        DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
        tt_draw.Draw(ds);
        ds.Release();
    }

The "IsIdle" part is only necessary if you want it to remove text automatically as soon as finished waiting for reader. You can change reading speed with tt_draw.TextReadTime. Or remove text by your own method.

[Cassiebsg]

Seems to be completely ignoring the settings at game start (I realized that game start wasn't doing anything in the room, and moved it to room_load) but seems to still be ignoring it.

Okay, I'll change that code, but I solved that problem by just adding [ at the end of the text.

[Crimson Wizard]

Seems to be completely ignoring the settings at game start (I realized that game start wasn't doing anything in the room, and moved it to room_load) but seems to still be ignoring it.

Well... there might be something very simple, like room_load not entered on events panel, or something like that.

[Cassiebsg]

No, it is linked, that's why I moved the code there.
I have other code in there that is being initialized in the room.

[Crimson Wizard]

Can you show the final code, please?

[Cassiebsg]

Code: ags

// text script for room
TypedTextDrawing tt_draw;
DynamicSprite *roomBkg; // will keep saved room background
 

function RestoreRoomBkg()
{
    // Restore original room background
    DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
    ds.DrawImage(0, 0, roomBkg.Graphic);
    ds.Release();
}
 
// Calling TypeOnDS will start typed text
function TypeOnDS(string st)
{
    if (roomBkg == null)
    {
        roomBkg = DynamicSprite.CreateFromBackground();
    }
    else
    {
        RestoreRoomBkg();
    }
    tt_draw.Start(st);
}
 
function repeatedly_execute()
{
}
 
D3D_Video* video;
TypedText my_text;
     
function repeatedly_execute_always() 
{   
    if (tt_draw.IsActive)
    {
        tt_draw.Tick(); // update TT
        if (tt_draw.IsIdle)
        {
            tt_draw.Clear();
            RestoreRoomBkg();
        }
        else
        {
            DrawingSurface *ds = Room.GetDrawingSurfaceForBackground();
            tt_draw.Draw(ds);
            ds.Release();
        }
    }
    if (my_text.IsActive)
    {
        my_text.Tick(); // update TypedText
        if (my_text.IsIdle)
        {
            my_text.Clear(); // clear the text
        }
        else
        {
            String text_to_show=my_text.CurrentString;
            if (my_text.IsCaretShown)
            {
                text_to_show=text_to_show.Append(""); // append carret symbol to the end of the text
            }
            cNarrat.SayBackground(text_to_show); // print typedText's current text 
        }
    }
}
 
function room_Load() 
{
    tt_draw.TypeDelay = 4;
    tt_draw.CaretFlashOnTime = 4;
    tt_draw.CaretFlashOffTime = 4;
    tt_draw.CaretStyle = eTypedCaret_Explicit; // draw caret
    tt_draw.CaretSprite = 1010; // put your sprite number here
    //tt_draw.TypeSound = aTypewriterTyping; // set sound to play
	
    tt_draw.X = 500;
    tt_draw.Y = Room.Height / 2;
    tt_draw.Width = 500 ;
    tt_draw.Height = Room.Height / 2 ;
    tt_draw.Font = eFontGalactican;
    tt_draw.TextAlign = eAlignLeft;
    // Config typed text
    my_text.TypeDelay=4;
    my_text.CaretFlashOnTime=4;
    my_text.CaretFlashOffTime=4;
    // End config of type text
	
    //	SetViewport(0, 0);
    cShuttle.Transparency=100;
    cShuttle.Baseline=288;
    cShuttle.ChangeRoom(1, 199, 139);
}

function TypeSay(String st)
{
    my_text.Start(st);
}



void Cutscene_Intro()
{	
    //bool Esc_CutScene=false;
    //D3D Plugin - playing background video with Theora-------------
    //Required for autoplay
    D3D.SetLoopsPerSecond( GetGameSpeed() );
    
    // Open video file
    video = D3D.OpenVideo( "Intro_Opening_v1.ogv" );
    
    if ( video )
    {
        // Use room coordinates
        video.relativeTo = eD3D_RelativeToRoom;
        
        // Anchor point to top left corner
        video.SetAnchor( -0.5, -0.5 );
        
        // Play!
        video.Autoplay();
    }
    else
    {
        player.SayBackground( "Couldn't open video." );
        
    }
    //END OF D3D plugin video---------------------------------------
    play_Music(Intro);
    StartCutscene(eSkipESCOnly);
    //	oGal.Visible=true;
    // oGal.SetView(60);
    TypeSay("An AGS game by Sandra T. Almeida[");
	 
    cNarrat.SayAt(6, 261, 500, "&1 There are those who believe");   
    cNarrat.SayAt(6, 261, 500, "&2 that life here began out there,");
    TypeSay("a fan game based on Battlestar Galactica[");
    cNarrat.SayAt(6, 261, 500, "&3 far across the universe,");
    cNarrat.SayAt(6, 261, 500, "&4 with tribes of humans");
    cNarrat.SayAt(6, 261, 500, "&5 who may have been the forefathers of the Egyptians");
    cNarrat.SayAt(6, 261, 500, "&6 or the Toltecs or the Mayans.");
    //  oGal.Animate(0, 1, eOnce, eNoBlock, eForwards);
    cNarrat.SayAt(6, 261, 500, "&7 Some believe that there may yet be brothers of man");
    cNarrat.SayAt(6, 261, 500, "&8 who even now fight to survive");
    cNarrat.SayAt(6, 261, 500, "&9 somewhere beyond the heavens.");
    play_Music(Main);
    while (video.NextFrame()) 
    {
        if (IsKeyPressed(eKeyEscape)) break;
        else Wait(1);
    }
    EndCutscene();
    video=null; 
    CloseM.Visible=false;
    gMenu.Visible=true;
}

function room_AfterFadeIn()
{
    if (Game.DoOnceOnly("Play Intro")) Cutscene_Intro();
}

void Cutscene_Start()
{	
    //D3D Plugin - playing background video with Theora-------------
    // Required for autoplay
    D3D.SetLoopsPerSecond( GetGameSpeed() );
    
    // Open video file
    video = D3D.OpenVideo( "test.ogg" );
    
    if ( video )
    {
        // Use room coordinates
        video.relativeTo = eD3D_RelativeToRoom;
        
        // Anchor point to top left corner
        video.SetAnchor( -0.5, -0.5 );
        
        // Play!
        video.Autoplay();
    }
    else
    {
        Display( "Couldn't open video." );
        //return;
    }
	//END OF D3D plugin video---------------------------------------
	
    SetGameSpeed(25); // you don't need to use the same fps as the video like this, but it's easiest this way*/
	
	
    cAthena.ChangeRoom(1, 1024, 0);
    cNarrat.ChangeRoom(1, -5, 0);
    cNarrat.SpeechView=97;
    cShuttle.SetAsPlayer();
    //cAthena.SpeechView=18;
    //oGal.StopAnimating();
    Start_Cutscene=false;
    StartCutscene(eSkipESCOnly);
    play_Music(Intro);
    oGal.Graphic=1213;
    oGal.Visible=true;
    oBay.Visible=true;
    cShuttle.Transparency=0;
    cShuttle.Walk(948, 201, eNoBlock, eAnywhere);
    //oShuttle.Visible=true;
    //oShuttle.Move(492, 201, -2, eNoBlock, eAnywhere);
    // oShuttle.SetView(VSHUTTLE);
    //oShuttle.Animate(0, 2000, eOnce, eNoBlock, eForwards);
    //cNarrat.SayAt(6, 261, 500, "&11 What's Starbuck's status?");
    cNarrat.Say("&11 What's Starbuck's status?");
    Wait(10);
    ReleaseViewport();
    //cAthena.SayAt(6, 261, 500, "&45 He's due on the Rising Star at any moment.");
    cAthena.Say("&45 He's due on the Rising Star at any moment.");
    Wait(5);
    cNarrat.Say("&12 I hope we don't have to move him to red before he eats.");
    //oShuttle.Move(939, 142, -2, eNoBlock, eAnywhere);
    cShuttle.Walk(948, 137, eNoBlock, eAnywhere);
    cAthena.Say("&46 Starbuck did ask me to dinner tonight but...");
    cAthena.Say("&47 Well, I do have this duty.");
    cAthena.Say("&48 I guess he'll have to eat alone.");
    cShuttle.Walk(948, 135, eNoBlock, eAnywhere);
    cNarrat.Say("&13 Well, er... perhaps this once we can make an exception, hm?");
    Wait(5);
    cNarrat.Say("&14 You go ahead and join him.");
    cNarrat.Say("&15 I'll handle this with Colonel Tigh.");
    //	oShuttle.Visible=false;
    Wait(60);
    oGal.Visible=false;
    oBay.Visible=false;
    EndCutscene();
    play_Music(Stb);
    cStarb.SetAsPlayer();
    video=null; 
    SetGameSpeed(SldSpeed.Value);
    player.ChangeRoom(2, 309, 582);
}


function room_RepExec()
{
    if (Start_Cutscene) Cutscene_Start();
}

EDIT: Indent was out of wack...

EDIT2: Maybe it's the characterSay? And the speech font is being enforced over the settings?

[Crimson Wizard]

But, you are not even calling TypeOnDS anywhere in your script, which means that SayBackground is the only thing that shows up.

Something I have to clarify, do you realize that you have TWO completely separate typedtexts in your script? And you are starting only one of them, which is called my_text, but not the one called tt_draw?

[Cassiebsg]

No, I told you I had no idea what I was doing. Not that as easy to use this module.

So, how do I call the tt_draw, then? And how do I call TypeOnDS??

Or: What code should I be using?

[Crimson Wizard]

No, I told you I had no idea what I was doing. Not that as easy to use this module.

So, how do I call the tt_draw, then? And how do I call TypeOnDS??

Or: What code should I be using?

It looks like you copied two different code examples into one script.
If you wanted to draw typed text on room background you only need one with TypedTextDrawing.
In your current script simply replace calls to TypeSay with calls to TypeOnDS. This function already exists in your script.


I will see if I am able to rewrite description to make it easier to understand how to use this module.

[Cassiebsg]

Okay, replacing TypeSay with TypeOnDS rproduces: Erro (line 137): Type mismatch: cannot convert 'const string' to 'string'

I looked at the code, and if I replace function TypeOnDS(string st) with function TypeOnDS(String st)
then it runs, but I can't see the text being printed on screen.

[Crimson Wizard]

Sorry, but I think this module is not ready. I am cancelling it until I have time to work more on it.

[Cassiebsg]

Oh.
And I was enjoying seeing the text printed there...

Hope you can fix it soon, and sorry for being a pain.

[Crimson Wizard]

Sorry, I think it did not work for you because you do not set tt_draw.TextColor, it is black by default, and if your room background is black, that would explain why you do not see anything.

[Cassiebsg]

Okay, I figured out why it's not working... seems like it can't render over my BG video?
I "removed" the code for the D3D pluging BG video, and now it's working. Looks really nice too!
Also thanks for the heads up with the TextColor code.
Do you think it's possible to render it over the video, like the speech is? If it's not it's okay, I'll just have to work something else out. Or add the text to the rendered video.

EDIT: Also, think you canceled the module too quick, seems to be working just fine, and that it's just my ineptitude to understand the complex code plus my other messy code that was on the way.
Only real needed change, seem to be in your example code, where you typed string s instead of String s.

[Crimson Wizard]

Okay, I figured out why it's not working... seems like it can't render over my BG video?

I don't know; that depends on how this video is rendered, which I never tried out myself. Maybe video gets drawn above text?
If video plugin can somehow return drawing surface of its own, you may draw upon it instead.

You may try using TypedTextOverlay or TypedTextLabel instead of TypedTextDrawing, if you have a possibility to use overlay/GUI in your room.


I will repost the module after I fix some errors and write easier explanation on how to use it.

[Cassiebsg]

I'll give it a try, can it be a transparent GUI/overlay?

I'm using the D3D plugin by AJA for the video rendering found here: http://www.adventuregamestudio.co.uk/forums/index.php?topic=45348.0
You can probably easily test it your self, if you like, by copy pasting my code into a new game's room, and just replace the video filename with any other ogv movie you might have laying around.

EDIT: No, text gets drawn over the video. At least the speech text does. Had no problem rendering the TextSay over it.

EDIT2: Okay, tried it with a GUI, I imported the footline code from your demo to test, and edited the lines relating to sounds out.
I got it to sorta work. It seems it can render over the video. Only it doesn't run while the speech is running. So, I only get the first line rendered once I hit the start button on the main menu, and my second video starts. Then the next comes first after the game has started (controling the character in a non-blocking way). So my guess right now is, the GUI lbl won't uptade if it's blocked.

Haven't tried overlay yet, since I have never used overlays before, meaning that it's even a bigger mystery for me.

EDIT3: Now I'm even more confuse... works even in blocked mode, but still not over my first video. This is weird, since the code is the same for both videos, is it not? (EDIT4: And now I'm at a loss... put my 1st video on the cutscene_start and then I get the text typed... with the cutscene_Intro it doesn't run... what is different? )

EDIT5: Okay, got it working with a GUI! Now I just need to change the lines to display my text and fine tune it!
Thanks, and sorry for being a noob.
And oh, am not sure what was wrong before, I changed 2 things, I moved the NextFootline(); to room_load() and added a variable to fire up my code in rep_exe... which ever of the two "fixes" was, it's working!

EDIT 6: Am I over doing this? Sorry.
Now I'm trying to complicate a simple thing... I am here trying to keep 2 lines on screen, instead of writing one line, clear, and then write a second line. I realized that I can just use the [ to break a line into 2, and I would do that, if I didn't want to use a smaller font on the 1st line and a bigger on the second.
I've managed to do it, by writing 2 lines simultaneous (though I would prefer to write one at a time), but the first line is still removed before the second. Is there a simple setting I can change, or this is not possible without some complicated rewrite?

[Crimson Wizard]

EDIT 6: Am I over doing this? Sorry.
Now I'm trying to complicate a simple thing... I am here trying to keep 2 lines on screen, instead of writing one line, clear, and then write a second line. I realized that I can just use the [ to break a line into 2, and I would do that, if I didn't want to use a smaller font on the 1st line and a bigger on the second.
I've managed to do it, by writing 2 lines simultaneous (though I would prefer to write one at a time), but the first line is still removed before the second. Is there a simple setting I can change, or this is not possible without some complicated rewrite?

If you want to have 2 different fonts then you will have to use 2 different objects, because right now TypedTextDrawing does not support changing font when typing, and Labels, Buttons and Overlays do not support multiple fonts on their own (and my module cannot make them do). So yes, you will need 2 Labels and TypewriterLabel objects, linked to each other. You actually did that, if I understand right?

If you want first line to stay you need to tell it not to clear text at all, or keep it for a long time. That depends on what function you use to run it.

If you are manually managing TypewriterLabel, then simply do not call "Clear" function for it.

If you are using Label.Typewriter extender function, then I realized that I did not provide option to keep it forever until you say to remove it, but there is a trick you can use: when you set up its properties with TypewriterPreset.SetGeneral, last parameter is "reading time". Simply set that reading time to some very big number (you may actually do same if you are using TypewriterLabel object yourself).

[Cassiebsg]

Yes, I'm actually using 6 labels in the GUI, because I wanted the text to be displayed in different places on screen, and thought it would be easier to print each line to a new label...
I'm pretty happy the way it's working now, except for the top label with the smaller font and the bottom label with the bigger font are printed at the same time.
I would love it to print the fist line, not clear the line, then type the second line, and then clear the two lines simultanoues when I move to print line 3 and 4.

I tried to figure where the clear was in the code, but failed to see it.

Here's the code I'm currently using:

Code: ags

#define footline_TYPEWRITER_PRESET 1

String footlines[];
int footline_count;
int footline_index;
int footline_tw;

function game_start()
{
  footline_count = 7;
  footlines = new String[footline_count];
  footlines[0] = "A fan game by     [";
  footlines[1] = "Sandra T. Almeida [";
  footlines[2] = "Made with             [";
  footlines[3] = "Adventure Game Studio [";
  footlines[4] = "based on the original TV show: [";
  footlines[5] = "Battlestar Galactica           [";
  footlines[6] = " ";
  footline_index = 0;
  footline_tw = NO_TYPEWRITER;
  
  //lblTypedText1.TextColor = 64960;
  //lblFootline.Font = eFontGalactican;
  lblTypedText1.Text = "";
  lblTypedText1t.Text = "";
  lblTypedText2.Text = "";
  lblTypedText2t.Text = "";
  lblTypedText3.Text = "";
  lblTypedText3t.Text = "";
  
  TypewriterPreset.SetGeneral(footline_TYPEWRITER_PRESET, 2, 4, eTypedDelay_LongSpace, 10);
  //TypewriterPreset.SetCaret(footline_TYPEWRITER_PRESET, 2, 4, eTypedCaret_Explicit, " ");
  //AudioClip *type_clips[] = new AudioClip[3];
  // type_clips[0] = aKeyboard;
  //type_clips[1] = aKeyboard2;
 // type_clips[2] = aKeyboard3;
 // TypewriterPreset.SetSoundArray(footline_TYPEWRITER_PRESET, type_clips, 3, null, aKeyboard_beep);
}

void NextFootline()
{
  if (!playingCredits)
  {
    if (footline_tw != NO_TYPEWRITER)
    {
      TypewriterRunners.Cancel(footline_tw);
    }
  }
}

function repeatedly_execute_always()
{
  if (!playingCredits)
  {
    if (footline_tw != NO_TYPEWRITER)
    {
      if (!TypewriterRunners.IsActive[footline_tw])
        footline_tw = NO_TYPEWRITER;
    }
    if (footline_tw == NO_TYPEWRITER)
    {
      if (Game.DoOnceOnly("1st intro line")) 
      {
        lblTypedText1t.Font = eFontOptimus;
        footline_tw = lblTypedText1t.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
        //lblTypedText1="";
        footline_index++;
        footline_tw = lblTypedText1.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      }
      else if (Game.DoOnceOnly("2nd intro line")) 
      {
        lblTypedText1t.Text="";
        footline_tw = lblTypedText2t.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
        footline_index++;
        footline_tw = lblTypedText2.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      }
        else if (Game.DoOnceOnly("3rd intro line")) 
      {
        lblTypedText2t.Text="";
        footline_tw = lblTypedText3t.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
        footline_index++;
        footline_tw = lblTypedText3.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      }
      footline_index++;
      if (footline_index == footline_count || footlines[footline_index] == null)
      {
        lblTypedText3.Text="";
        footline_index = 6;
      }
    }
  }
}

The label ending in t is the top line with the smaller font.

But don't go out of your way if making it work slightly different is too much of a pain. It's just a little fine tune to make it 1% better (in my eyes, that is).

EDIT: Fixed the indent... seems like the forum doesn't like my copy/pastes from the editor (I'm using tab for indent there...)

[Crimson Wizard]

The first error in this script is that you are remembering all typewriter indexes in same variable, and since some of them run simultaneously or have to stay on screen for some time, it gets overwritten every time and you loose control over previous ones.
Also, you are starting two lines at the same time, that's why... they are typing at same time.

Instead of "int footline_tw" you need "int footline_tw[N]", where N is the number of labels you have, or at least the number of simultaneous typewriters, whichever is more convenient.

As I mentioned earlier, you need to set read time to some big number to prevent automatic removal of a text.

Code: ags

TypewriterPreset.SetGeneral(footline_TYPEWRITER_PRESET, 2, 4, eTypedDelay_LongSpace, 1000); // notice 1000

The code may look something like:

Code: ags

function repeatedly_execute_always()
{
  if (footline_tw[0] == NO_TYPEWRITER) // first typewriter was not started yet
  {
    if (Game.DoOnceOnly("1st intro line SMALL FONT"))
    {
      // start first line
      footline_tw = lblTypedText1t.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      footline_index++;
    }
  }
  if (footline_tw[0] != NO_TYPEWRITER && !TypewriterRunners.IsActive[footline_tw[0]]) // first typewriter has started and finished typing
  {
    if (Game.DoOnceOnly("1st intro line BIG FONT"))
    {
      // start second line 
      footline_tw[1] = lblTypedText1.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      footline_index++;
    }
  }
  if (footline_tw[1] != NO_TYPEWRITER && !TypewriterRunners.IsActive[footline_tw[1]]) // second typewriter has started and finished typing
  {
    if (Game.DoOnceOnly("2nd intro line SMALL FONT"))
    {
      // Remove first two lines
      TypewriterRunners.Cancel(footline_tw[0]);
      TypewriterRunners.Cancel(footline_tw[1]);
      // Start third line
      footline_tw[2] = lblTypedText2t.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      footline_index++;
    }
  }
  if (footline_tw[2] != NO_TYPEWRITER && !TypewriterRunners.IsActive[footline_tw[2]]) // third typewriter has started and finished typing
  {
    if (Game.DoOnceOnly("2nd intro line BIG FONT"))
    {
      // start fourth line 
      footline_tw[3] = lblTypedText3.Typewriter(footlines[footline_index], eNoBlock, footline_TYPEWRITER_PRESET);
      footline_index++;
    }
  }

  // and so on...
}

There should be more optimal way to do this, but my brain is not working well right now.

[Cassiebsg]

Yes, I knew why they were writing simultaneous, just not how to stop the first line from being removed.
I'll give a try, and thanks bunch for the help and the module!


EDIT: Been trying this but now the second line (or any other after the 1st) never starts... Not sure what I did wrong, probably the arrays?

[Crimson Wizard]

EDIT: Been trying this but now the second line (or any other after the 1st) never starts... Not sure what I did wrong, probably the arrays?

Can you post your current code again?

[Cassiebsg]

Sure, though it's quiet a mess atm, since I started testing other ways in the hopes to figure this out.

Code: ags

#define introline_TYPEWRITER_PRESET 2

String introlines_Small[];
String introlines_Big[];
int introline_Small_count;
int introline_Small_index;
int introline_Big_count;
int introline_Big_index;
int introline_Big_tw[1]; // Number of typewriters
int introline_Small_tw[1]; // Number of typewriters

function game_start()
{
  introline_Big_count = 4;
  introlines_Big = new String[introline_Big_count];
  introlines_Big[0] = "Sandra T. Almeida [";
  introlines_Big[1] = "Adventure Game Studio [";
  introlines_Big[2] = "Battlestar Galactica           [";
  introlines_Big[3] = " ";
  introline_Big_index = 0;
	
	
  introline_Small_count = 4;
  introlines_Small = new String[introline_Small_count];
  introlines_Small[0] = "A fan game by     [";
  introlines_Small[1] = "Made with             [";
  introlines_Small[2] = "based on the original TV show: [";
  introlines_Small[3] = " ";
  introline_Small_index = 0;
	
  introline_Big_tw[0] = NO_TYPEWRITER;
  introline_Small_tw[0] = NO_TYPEWRITER;
  
  //lblTypedText1.TextColor = 64960;
  //lblintroline.Font = eFontGalactican;
  lblTypedText1.Text = "";
  lblTypedText1t.Text = "";
  lblTypedText2.Text = "";
  lblTypedText2t.Text = "";
  lblTypedText3.Text = "";
  lblTypedText3t.Text = "";
  
  TypewriterPreset.SetGeneral(introline_TYPEWRITER_PRESET, 2, 4, eTypedDelay_Mixed, 200); // long reading time so it stays on screen
  //TypewriterPreset.SetGeneral(introline_TYPEWRITER_PRESET, eTypedDelay_Mixed, 20); // long reading time so it stays on screen
  //TypewriterPreset.SetCaret(introline_TYPEWRITER_PRESET, 2, 4, eTypedCaret_Explicit, " ");
  //AudioClip *type_clips[] = new AudioClip[3];
 // type_clips[0] = aKeyboard;
  //type_clips[1] = aKeyboard2;
 // type_clips[2] = aKeyboard3;
 // TypewriterPreset.SetSoundArray(introline_TYPEWRITER_PRESET, type_clips, 3, null, aKeyboard_beep);
}

void NextIntroline()
{
	/*if (!playingCredits)
	{
		if (introline_tw[0] != NO_TYPEWRITER)
		{
			TypewriterRunners.Cancel(introline_tw[introline_index]);
		}
		if (introline_tw[1] != NO_TYPEWRITER)
		{
			TypewriterRunners.Cancel(introline_tw[introline_index]);
		}
	}*/
}

function repeatedly_execute_always()
{
	if (!playingCredits)
	{
    /*if (introline_tw[0] != NO_TYPEWRITER)
    {
      if (!TypewriterRunners.IsActive[introline_tw[0]])  
			{
				introline_tw[0] = NO_TYPEWRITER;
			}
    }
    else if (introline_tw[1] != NO_TYPEWRITER)
		{
      if (!TypewriterRunners.IsActive[introline_tw[1]])  introline_tw[1] = NO_TYPEWRITER;
    }*/
		//if (introline_tw[0] != NO_TYPEWRITER && !TypewriterRunners.IsActive[0]) gHelp.Visible=true;
		
		if (introline_Small_tw[0] == NO_TYPEWRITER) // first typewriter was not started yet
		{
			player.SayBackground("test");
			if (Game.DoOnceOnly("1st intro line SMALL FONT"))
			{
				// start first line
				introline_Small_tw[0] = lblTypedText1t.Typewriter(introlines_Small[introline_Small_index], eNoBlock, introline_TYPEWRITER_PRESET);
				introline_Small_index++;
			}
		}
		if (introline_Small_tw[0] != NO_TYPEWRITER && !TypewriterRunners.IsActive[0]) // first typewriter has started and finished typing
		{
			if (Game.DoOnceOnly("1st intro line BIG FONT"))
			{
				// start second line 
				introline_Big_tw[0] = lblTypedText1.Typewriter(introlines_Big[introline_Big_index], eNoBlock, introline_TYPEWRITER_PRESET);
				introline_Big_index++;
			}
		}
		/*if (introline_tw[1] != NO_TYPEWRITER && !TypewriterRunners.IsActive[introline_tw[1]]) // second typewriter has started and finished typing
		{
			if (Game.DoOnceOnly("2nd intro line SMALL FONT"))
			{
				// Remove first two lines
				TypewriterRunners.Cancel(introline_tw[0]);
				TypewriterRunners.Cancel(introline_tw[1]);
				// Start third line
				introline_tw[2] = lblTypedText2t.Typewriter(introlines[introline_index], eNoBlock, introline_TYPEWRITER_PRESET);
				introline_index++;
			}
		}
		if (introline_tw[2] != NO_TYPEWRITER && !TypewriterRunners.IsActive[introline_tw[2]]) // third typewriter has started and finished typing
		{
			if (Game.DoOnceOnly("2nd intro line BIG FONT"))
			{
				// start fourth line 
				introline_tw[3] = lblTypedText3.Typewriter(introlines[introline_index], eNoBlock, introline_TYPEWRITER_PRESET);
				introline_index++;
			}
		}*/
		if (introline_Big_index == introline_Big_count || introlines_Big[introline_Big_index] == null)
		{
			lblTypedText3.Text="END";
			introline_Big_index = 4;
		}
	}
}

Even tried to test that the code was detecting the introline_tw[0] != NO_TYPEWRITER && !TypewriterRunners.IsActive[0] by opening a GUI, but instead of opening the GUI after it finished typing, it opened it immediately after the 1st letter was written.
Also tried to separate the lines into Small and Big, but didn't helped either.

If I put 1000 in the reading delay, it'll hang forever in the 1st line and never start the second, as it is now, it's still writing both lines at the same time.

EDIT: Any help here? I've also tried now to create 2 different typewriters (but module seems to ignore this, and use the last line as setting for both lines), by separating the #Define, made one for the small and one for the big, created 2 lines of TypeWriterPreset, one for the small and one for the big... yet I still only get the same result. 
It's like it doesn't really detect when the first line is done writing, and thus only starts writing the next once the first is removed from screen. Wich results if I put 10 in the reading speed it types the first, removes it and then writes the second line. If I put 1000, like you suggest, it writes the 1st line and will never write the second line before the sequence is over. 

Also tried variants on the second if condition and still all I get is either both at the same time, or the 2nd after the 1st got removed. 

[Crimson Wizard]

My suggestion does not work because IsActive returns true until automatic typewriter clears text, and you do not need the text to be cleared until some other time.
You could use timer instead to know when start next typewriter.

But I think best way for now is to use one manual typewriter and just switch label it prints on. This will leave text on previous label until you explicitly tell it to clear.

Code: ags

String introlines[];
int introline_index;
int introline_count;
bool playingCredits;

TypewriterLabel twl;
 
function game_start()
{
  introline_count = 7;
  introlines = new String[introline_count];
  introlines[0] = "A fan game by     [";
  introlines[1] = "Sandra T. Almeida [";
  introlines[2] = "Made with             [";
  introlines[3] = "Adventure Game Studio [";
  introlines[4] = "based on the original TV show: [";
  introlines[5] = "Battlestar Galactica           [";
  introlines[6] = " ";
  introline_index = 0;
  
  lblTypedText1.Text = "";
  lblTypedText1t.Text = "";
  lblTypedText2.Text = "";
  lblTypedText2t.Text = "";
  lblTypedText3.Text = "";
  lblTypedText3t.Text = "";
  
  twl.TypeDelayMin = 2;
  twl.TypeDelayMax = 4;
  twl.TypeDelayStyle = eTypedDelay_Mixed;
  twl.TextReadTime = 5;
}
 
function repeatedly_execute_always()
{
        if (!playingCredits)
        {
                if (twl.IsActive)
                  twl.Tick();
          
                if (introline_index == 0) // typewriter has not start to type the first line yet
                {
                        // start first line
                        twl.TypeOnLabel = lblTypedText1t;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 1 && twl.IsIdle) // typewriter finished typing first line
                {
                        // start second line 
                        twl.TypeOnLabel = lblTypedText1;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 2 && twl.IsIdle) // typewriter finished typing second line
                {
                        // clear previous
                        lblTypedText1.Text = "";
                        lblTypedText1t.Text = "";
                        // start third line 
                        twl.TypeOnLabel = lblTypedText2t;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 3 && twl.IsIdle) // typewriter finished typing 3rd line
                {
                        twl.TypeOnLabel = lblTypedText2;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 4 && twl.IsIdle) // typewriter finished typing 4th line
                {
                        // clear previous
                        lblTypedText2.Text = "";
                        lblTypedText2t.Text = "";
                        twl.TypeOnLabel = lblTypedText3t;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 5 && twl.IsIdle) // typewriter finished typing 5th line
                {
                        twl.TypeOnLabel = lblTypedText3;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 6 && twl.IsIdle) // typewriter finished typing 5th line
                {
                        // clear previous
                        lblTypedText3.Text = "";
                        lblTypedText3t.Text = "";
                        twl.TypeOnLabel = null;
                        twl.Clear();
                }
        }
}

[Cassiebsg]

Oh, cool! Thanks for the reply! 

I'll go ahead and test it right now! If it works I can finally start writing all the credits text. 

EDIT: Cool! It's working!     
Gave me an error though on another part of the code, so I'll have to figure it out, and hopefully I can figure it out without having to bother you again. 

EDIT2: Okay, I managed to solve it, but had to remove this last line at the end twl.Clear();, as it was causing a null pointer reference.
Though, seems to be working just fine without the line. 

EDIT3 : I moved on to make a credits section (new script, with all introline changed to creditline, and the typewriter is now called twlC, only I can only run the credits once.  If I put the twl.Clear(); I get the null pointer reference at the end, if I remove it I get the null pointer reference at the start or the second run of credits. 
Think I'll try and see if I can put the line someplace else, outside rep_exe_always and see if that helps. 

EDIT4: I noticed, after doing a search for the function, that IniFile also had a void Clear()... I changed the name of it, and that solved the problem of the null pointer reference. 

[Crimson Wizard]

EDIT3 : I moved on to make a credits section (new script, with all introline changed to creditline, and the typewriter is now called twlC, only I can only run the credits once.  If I put the twl.Clear(); I get the null pointer reference at the end, if I remove it I get the null pointer reference at the start or the second run of credits. 
Think I'll try and see if I can put the line someplace else, outside rep_exe_always and see if that helps. 

EDIT4: I noticed, after doing a search for the function, that IniFile also had a void Clear()... I changed the name of it, and that solved the problem of the null pointer reference. 

Wait wait... what? Are you saying there is a bug that having two same functions in two types of objects may lead to error when calling it?

TBH I was sure twl.Clear() was causing errors because I did "twl.TypeOnLabel = null;" just before that, and Clear uses TypeOnLabel reference without checking if its null.

[Cassiebsg]

Guess that's what I'm saying?
At least after I changed the name, the error stopped and all is running just fine.

I was a little more surprised that the AGS allows two void/function be called the same in game. I thought it would complain if the name had already been used.

EDIT:

Ermmm... it's me again...
Is it possible to type more than one line in the same label? First I tried to do something like:

Code: ags

  introlines[4] = "based on the original TV show: [ 
                           Battlestar Galactica           [";

But it complains with a : undefined symbol 'Battlestar' ... 
I thought that as long as the " was open, it would not complain with such a thing.  Putting it all into one long line, works up to the point when there's no more space and AGS breaks the line, and then I'm back to the above problem...
Is there maybe an append command? so that the next line starts typing after the previous? Right now if I do

Code: ags

                else if (introline_index == 4 && twl.IsIdle) // typewriter finished typing 4th line
                {
                        // clear previous
                        lblTypedText2.Text = "";
                        lblTypedText2t.Text = "";
                        twl.TypeOnLabel = lblTypedText3t;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 5 && twl.IsIdle) // typewriter finished typing 5th line
                {
                        twl.TypeOnLabel = lblTypedText3;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }
                else if (introline_index == 6 && twl.IsIdle) // typewriter finished typing 6
                {
                        twl.TypeOnLabel = lblTypedText3;
                        twl.Start(introlines[introline_index]);
                        introline_index++;
                }

It will type the text on label 3, and then clear it and type the next text on the label.

So right now, I'm thinking that the only option is to make a label for each line?  Sounds a bit over kill though. 

[Crimson Wizard]

Cassie, you keep adding updates to the same post after WEEKS, and I do not notice them in time: the main forum page does not display "new posts" icon in this case, so I don't check the thread.

I went here just by luck, because there was a new post in another module topic.


Regarding your question, for some reason AGS script editor does not support multiline strings. You do this instead:

Code: ags

String s = "Some string";
s = s.Append("Longer string");
s = s.Append("Even more longer string");

[Cassiebsg]

Okay, thanks for the help. 

Sorry about the editing thing... just not that easy to figure out when it's okay to double post and when it's not. 
And since I found out that it does indeed show "new" in the post topic after an editing, I thought that should then be good enough.
I too would love these "edit new" to show up in the "Show unread posts since last visit." As I often also miss edited posts.

But don't worry, I wasn't getting desperate or anything. Had decided that I could probably solve this by adding a couple more labels, and just add as much in one line as possible.

EDIT: Just saying it works!  Thanks bunch. Now I just need to format the text so it looks nice. 

[Aaron Best]

Hi,

I'm trying to utilise this module, however I'm having a slight issue and I'm wondering if anyone can help me?

I'm using the TypewriterLabel function, and have replicated the code above pretty much exactly, however I'm finding that when running the game, the gui label writes out perfectly except for the last word which goes onto a separate line below the rest of the text.

I've tried using different labels of different sizes but it always seems to be the case.

any ideas?

[Cassiebsg]

Well, you could post the code so we can see if there's something in there causing the line break.

In the mean time, I would say make sure the label is wide enough to fit the text, just try and give it a few pixels more to the sides and see if that helps.
check that you do not have a [ before the last word. Try to add a space to the end of the line, after your last word.

[Crimson Wizard]

Yes, the first guess will be that you have '[' character in the string which is used as a linebreak in AGS.

On a side note, I realized there is a functionality limitation in this module that it cannot handle "escaped" linebreaks, e.g. "\\[" will still break line, although it must print '[' character (it does in common functions like Display(...)).

[Phemar]

This is really cool, Crimson! Glad to see a more fleshed out version of the typewriter module. Awesome work.

[Aaron Best]

Hi apologies with the delayed response...

No there's certainly no [ in the text - however adding a space after the final word has seemed to resolve the issue.

Thank you for your assistance.

[Crimson Wizard]

No there's certainly no [ in the text - however adding a space after the final word has seemed to resolve the issue.

Could you give an example of text that caused this? Does this happen with any text or particular one? Depends on font? This information would be very useful to prevent this error in the future.

[Cassiebsg]

Uhm, I think it happens with all text in the module, maybe?
I remember adding the space on my lines, cause I was experiencing the same problem with the line breaking (which is why I suggested the space at the end).
I didn't thought much about it at the time. I was using ttf font if that makes a difference.

[eri0o]

Hey, two minor things

• in the first example, it should be SayBackground, with the S upper case
• in the module code, the alignment centre is now center in 3.6.0, so there's I think three lines that need to be updated in the code - I think it's the renderer code

Used the module for the first time, it's really good!

[Crimson Wizard]

Updated TypedText modules to 1.0.0

After several years of not touching this module, I fixed couple of known bugs, added fixes for changed script commands to ease usage in AGS 3.5.0 and later, and replaced download links from bitbucket to github (where my script modules now reside).

* Fixed that if text does not end with any of the "split" characters (any punctuation by default), then the last word will be unnecessarily wrapped onto the next line.
* Fixed if drawing surface or control's height is too small, there will be no text typed at all, which may confuse users.
* Provided compat fixes for compiling with AGS 3.5.0 and higher.

Download module pack: https://github.com/ivan-mogilko/ags-script-modules/releases/download/typedtext-1.0.0/TypedTextPack.zip
Download demo game: https://github.com/ivan-mogilko/ags-script-modules/releases/download/typedtext-1.0.0/TypedTextDemo_1.0.0.zip

On another topic, the original documentation for this module is probably overcomplicated (as most of my attempts to document my work). A while ago I did an effort to write better docs for my DragDrop module, perhaps if I manage to find spare time I could do same for this module.

Also, this module maybe should be rewritten for AGS 4.0, where scripts have more features, and many things could be scripted easier and in a more elegant way.

[TypewriterTextLover]

Hello! I am complete noob and this is my first post! I have been messing around with the TypedText1.00 demo and module for a few days and struggling to figure out a few things.

I have been able to successfully get words to type on a object (dynamic sprite that looks like a piece of paper) just like in the demo. However the typewriter always seems "active" and ttdraw is never in a "waiting for reader" or "idle" stage. I can't figure out how to get it to stop! I understand it's being repeatedly executed to create the typing effect with ttdraw.tick.

I have tried using ClearTypewriter (usually get error messages with this since it deletes the sprite), ttdraw.Clear (which does clear the text but doesn't allow time for the ttdraw.Start(String) to finish. I have tried using timers to get around this with no success. I have also tried messing with ttdraw.TextReadTime which doesn't seem to have any effect.

I basically want to :

- Look at an hotspot or object.
- Typewriter starts typing word description on paper.
- If the words are too many for the text box: stop, let user click when done reading, user clicks, text clears, and typewriter continues writing from top.
- Click on paper to skip to the next text section.

I am sticking with TypedTextDrawing since it's the only feature that supports caret sprites. I have it working near perfectly, but just need to figure out this one final part. Any help is greatly appreciated!!! Here is my code. This code does not produce any errors, but doesn't do what I want either It's mostly the same from the demo. I have tried incorporating some of the PhylactereTypewriter code (since I believe it also uses dynamic sprites) which maybe has the solution to the problem there, but I couldn't figure it out. I think getting the typewriter to idle is the first step.

Code: ags

// room script file

// Compatibility macros
#ifndef SCRIPT_API_v350
  #define eAlignCenter eAlignCentre
#endif

TypedTextDrawing ttdraw;
DynamicSprite *papersprite;
int paper_original_pos;

void ClearTypewriter()
{
if (papersprite != null)
   papersprite.Delete();
  papersprite = null;
  ttdraw.Clear();
  oPaper.Y = paper_original_pos;
 }

void StartTypewriter()
{ oPaper.Visible=true;
 ClearTypewriter();
  
  papersprite = DynamicSprite.CreateFromExistingSprite(369);
  oPaper.Graphic = papersprite.Graphic;
 
  ttdraw.X = 2;
  ttdraw.Y = 4;
  ttdraw.LineSpacing = 5;
  ttdraw.Width = papersprite.Width;
  ttdraw.Height = papersprite.Height;
  ttdraw.Font = eFontPressStart2P;
  ttdraw.BkgColor = Game.GetColorFromRGB(226,175,143);
  ttdraw.TextColor = Game.GetColorFromRGB(0, 0, 0);
  ttdraw.TextAlign = eAlignLeft;
  ttdraw.CaretSprite = 79;
  ttdraw.TypeDelayMin = 2;
  ttdraw.TypeDelayMax = 4;
  ttdraw.TypeDelayStyle = eTypedDelay_Mixed;
  ttdraw.CaretFlashOnTime = 9;
  ttdraw.CaretFlashOffTime = 9;
  ttdraw.CaretStyle = eTypedCaret_Explicit;
  
  AudioClip *type_clips[] = new AudioClip[3];
  type_clips[0] = aType;
  type_clips[1] = aType2;
  type_clips[2] = aType3;
  ttdraw.SetRandomTypeSounds(type_clips, 3);
  ttdraw.CaretSound = aCaret;
}

void UpdateTypewriter()
{
  if (ttdraw.IsActive)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ttdraw.Draw(ds);
    ds.Release();
    // oPaper.Y = paper_original_pos -  * (ttdraw.LineHeight + ttdraw.LineSpacing);
    oPaper.Graphic = papersprite.Graphic;
  }
  }

void PaperLines()
{
gGuiLine1.Visible=true;
gGuiLine2.Visible=true;
}

function room_Load()
{
  paper_original_pos = oPaper.Y;
  gGuiIntro.Visible=false;
  Verbs.HideGui();
  StartTypewriter();
  ttdraw.Start("Your sister's kids are here to celebrate your birthday!");
  aHaunted_House.Play();
}

function oPaper_AnyClick()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Skip();
    // oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
  }
  else
  {
    oPaper.Visible=false;
      gGuiLine1.Visible=false;
    gGuiLine2.Visible=false;
    Verbs.ShowGui();
  }
}

function room_RepExec()
{
  UpdateTypewriter();
}

function hHotspotBabyEmmie_Look(Hotspot *theHotspot, CursorMode mode)
{
Verbs.HideGui();
  PaperLines();
  StartTypewriter();
ttdraw.Start("Look it's Baby Emmie! Awwww! How cute! Blah blah blah blah blah blah blah blah blah blah blah");
}

[Crimson Wizard]

- If the words are too many for the text box: stop, let user click when done reading, user clicks, text clears, and typewriter continues writing from top.
- Click on paper to skip to the next text section.

This module itself does not split text into "sections" or "pages", it has no such functionality. It only splits into lines according to the defined "width" of a text space.
If you like to display a longer text split into pages, where a text space is filled to max, waits, and then starts typing next page, then you should script this yourself on top of the typewriter object. You need some custom system that:
- accepts a input text
- calculates how much text lines can fit into the typewriter's space at once (see functions like GetTextWidth, GetTextHeight, etc)
- splits this input text into substrings, each representing a "page", and stores these in a String array
- remembers which page is currently being printed
- lets to order next page, in which case it stops current typing and starts it again with the next string from array.
- lets to know if this is the last page.


My memories of the demo game are rather vague (it's been several years), but I think I simply hardcoded these "pages" there, they are not calculated by size. So that approach from demo game won't be enough.

[TypewriterTextLover]

Thanks Crimson Wizard for the quick response and thank you for creating such a great module! This module has over 700,000 views which shows you how desired this feature is to people! The # 1 most viewed module!

Is there any way to get the typewriter to be in a "Waiting for user" or "IsIdle" state? I have used Display commands to see if it ever goes in a Idle status and it does not. If the typewriter would idle, i could simply say if typewriter idle, then clear, and start typing new string.

Another possible method maybe uses the "[" character. Is there way to say "if typewriter typed "[", then clear typewriter, and type new string? I believe there is a ttdraw.LastChar parameter that maybe useful?

[Crimson Wizard]

Thanks Crimson Wizard for the quick response and thank you for creating such a great module! This module has over 700,000 views which shows you how desired this feature is to people! The # 1 most viewed module!

Well, thank you, although even though there are many views, I never had statistics about actual number of uses.

Is there any way to get the typewriter to be in a "Waiting for user" or "IsIdle" state? I have used Display commands to see if it ever goes in a Idle status and it does not. If the typewriter would idle, i could simply say if typewriter idle, then clear, and start typing new string.

Indeed, that's how it is supposed to work.
If you open the Demo Game that is distributed along with the module, you may add a small test for the big typewriter machine:
- Add some kind of a "status bar" gui with a label, for example on top of the screen.
- Put this inside "void UpdateTypewriter()" function in a room script:

Code: ags

Label1.Text = String.Format("ttdraw active: %d, idle %d, wait %d", ttdraw.IsActive, ttdraw.IsIdle, ttdraw.IsWaitingForReader);

- Then run the game and click on a typewriter's keyboard.
You will notice that:
- At game start "active" is false, and "idle" is true.
- After you start it, "active" becomes true and "idle false.
- As soon as it is done typing, "idle" becomes true.

It does work in the demo game. The question then is how to use this properly in your case.

Another possible method maybe uses the "[" character. Is there way to say "if typewriter typed "[", then clear typewriter, and type new string? I believe there is a ttdraw.LastChar parameter that maybe useful?

I would not recommend that, the "[" character is used to wrap lines, and may be typed multiple times during the same text.

[TypewriterTextLover]

I used your line of code and it does indeed idle!!! I still can't get it clear the page by using it's idle status.

I have changed the void UpdateTypewriter() line to reflect if the typewriter is idle or !idle since it's only inactive once before use which isn't really helpful.
It also never enters a "wait for reader" status, although I'm not sure if that is an issue or not.

Here is what I changed it to, although it doesn't work:

Code: ags

void UpdateTypewriter()
{
  if (!ttdraw.IsIdle)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ttdraw.Draw(ds);
    ds.Release();
    //oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
    oPaper.Graphic = papersprite.Graphic;
    Label1.Text = String.Format("ttdraw active: %d, idle %d, wait %d", ttdraw.IsActive, ttdraw.IsIdle, ttdraw.IsWaitingForReader);
  }
  
  else
  {
    ttdraw.Clear();
  }
}

Doesn't seem like ttdraw.Clear isn't doing what it needs to do here? I've tried a couple of different things, but I'm stumped! This is the code for ttdraw.Clear but I can't seem to figure out if it maybe needs changing?

Code: ags

//===========================================================================
//
// TypedTextDrawing::Clear
//
//===========================================================================
void TypedTextDrawing::Clear()
{
  this._RenderClear();
  this._lineCount = 0;
}

I appreciate your time and help!

[Crimson Wizard]

It also never enters a "wait for reader" status, although I'm not sure if that is an issue or not.

This "wait for reader" state is entered if the text ended typing, but the typewriter "thinks" that player did not finish reading yet. This is achieved by roughly calculating amount of time necessary to read whole text, multiplying text's length by TextReadTime parameter. If text is typed slower than the resulting reading time, then "waiting" state will never be entered.

Here is what I changed it to, although it doesn't work:

Doesn't seem like ttdraw.Clear isn't doing what it needs to do here?

What does it not doing? what is the behavior you are trying to achieve with this code?

Note that Clear() does not clear the sprite, it resets the typewriter state. If you like sprite to be cleared, that would be:

Code: ags

    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear( some color );
    ds.Release();

EDIT: Also, you have this line with label text under "if (!idle)" condition, so it will never display idle off (if that matters).

[TypewriterTextLover]

I was able to get the page to clear by changing the void UpdateTypewriter() by using your code:

Code: ags

void UpdateTypewriter()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ttdraw.Draw(ds);
    ds.Release();
    //oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
    oPaper.Graphic = papersprite.Graphic;
    Label1.Text = String.Format("ttdraw active: %d, idle %d, wait %d", ttdraw.IsActive, ttdraw.IsIdle, ttdraw.IsWaitingForReader);
  }
  if (ttdraw.IsActive && ttdraw.IsIdle)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear(65535);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;
  }
}

However now I want to be able to display two strings back to back, so it looks like two different pages of text are being typed. I tried using this code, but it just ignores the first string and prints only the second:

Code: ags

  void StartTypewriter()
{
  ClearTypewriter();
  SayCustom("Launch the big typewriter!");
  
  papersprite = DynamicSprite.CreateFromExistingSprite(28);
  oPaper.Graphic = papersprite.Graphic;
  
  //Display("paper size = %d x %d", papersprite.Width, papersprite.Height);
  ttdraw.X = 4;
  ttdraw.Y = 4;
  ttdraw.Width = papersprite.Width - 8;
  ttdraw.Height = papersprite.Height - 8;
  ttdraw.Font = eFontFont3;
  ttdraw.BkgColor = Game.GetColorFromRGB(255, 255, 255);
  ttdraw.TextColor = Game.GetColorFromRGB(66, 44, 123);
  ttdraw.TextAlign = eAlignCenter;
  ttdraw.CaretSprite = 29;
  ttdraw.TypeDelayMin = 4;
  ttdraw.TypeDelayMax = 7;
  ttdraw.TypeDelayStyle = eTypedDelay_Mixed;
  ttdraw.CaretFlashOnTime = 9;
  ttdraw.CaretFlashOffTime = 9;
  ttdraw.CaretStyle = eTypedCaret_Explicit;
  
  AudioClip *type_clips[] = new AudioClip[3];
  type_clips[0] = aType;
  type_clips[1] = aType2;
  type_clips[2] = aType3;
  ttdraw.SetRandomTypeSounds(type_clips, 3);
  ttdraw.CaretSound = aCaret;
  
  String big_string = "The TypedTextDrawing prints TypedText on the provided DrawingSurface. Therefore";
  String big_string2 = "Furthermore, you may assign sprite number to CaretSprite property, and it will be used to draw caret position.";
  
  ttdraw.Start(big_string);
  ttdraw.Start(big_string2);
}

I tried looking at string arrays and looked over footlines and guybrushlines but I can't figure it out.

[Crimson Wizard]

Well, at this point this becomes a generic coding problem. You need to run two commands, but not immediately, because the second will overwrite the first one. Instead you need to run the second command after you learn that the first one completes.

Code: ags

  if (ttdraw.IsActive && ttdraw.IsIdle)
  {
    ttdraw.Clear();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear(65535);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;

    <------------ HERE
  }

How to do that?
Make an array of strings of certain limit.
Make a function that schedules next string.
Keep record of current string.


Following is the most basic example that I may come with. You may use this directly, or as a reference for your own code, and expand from there:

Code: ags

#define MAX_PAGES 100
String PageStrings[MAX_PAGES];
int TotalPages = 0; // remember how many pages scheduled
int CurrentPage = -1; // remember which is the current page

function ClearPages()
{
    TotalPages = 0;
    CurrentPage = -1;
}

function AddPage(String text)
{
    if (TotalPages == MAX_PAGES)
        return; // no more place to store pages
    PageStrings[TotalPages] = text;
    TotalPages++;
}

function StartTypeNextPage()
{
    if (CurrentPage < TotalPages - 1) // has more pages to display?
    {
        CurrentPage++;
        ttdraw.Start(PageStrings[CurrentPage]);
    }
}

And then in UpdateTypewriter():

Code: ags

  if (ttdraw.IsActive && ttdraw.IsIdle)
  {
    ttdraw.Clear();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear(65535);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;

    StartTypeNextPage();
  }

Use AddPage(text) to schedule a number of pages, then call StartTypeNextPage() to start with the first page whenever you need to.

[TypewriterTextLover]

IT WORKS!! I added some Waits and and a little bit of TextReaderType to make it work buttery smooth. Clicking on the typewriter now starts it. Clicking on the page will skip to the next page. This demo can print out books now!!!

Check it out here is the code for all that need it!!!

Code: ags

// room script file
// Compatibility macros

#ifndef SCRIPT_API_v350
  #define eAlignCenter eAlignCentre
#endif

#define MAX_PAGES 100

String PageStrings[MAX_PAGES];
int TotalPages = 0; // remember how many pages scheduled
int CurrentPage = -1; // remember which is the current page

TypedTextDrawing ttdraw;
DynamicSprite *papersprite;
int paper_original_pos;

function ClearPages()
{
    TotalPages = 0;
    CurrentPage = -1;
}

function AddPage(String text)
{
    if (TotalPages == MAX_PAGES)
        return; // no more place to store pages
    PageStrings[TotalPages] = text;
    TotalPages++;
}

function StartTypeNextPage()
{   if (CurrentPage < TotalPages - 1) // has more pages to display?
    {
        CurrentPage++;
        ttdraw.Start(PageStrings[CurrentPage]);
    }
}

void ClearTypewriter()
{
  if (papersprite != null)
    papersprite.Delete();
  papersprite = null;
  ttdraw.Clear();
  oPaper.Y = paper_original_pos;
}

void StartTypewriter()
{
  ClearTypewriter();
  SayCustom("Launch the big typewriter!");
  
  papersprite = DynamicSprite.CreateFromExistingSprite(28);
  oPaper.Graphic = papersprite.Graphic;
  
  //Display("paper size = %d x %d", papersprite.Width, papersprite.Height);
  ttdraw.X = 4;
  ttdraw.Y = 4;
  ttdraw.Width = papersprite.Width - 8;
  ttdraw.Height = papersprite.Height - 8;
  ttdraw.Font = eFontFont3;
  ttdraw.BkgColor = Game.GetColorFromRGB(255, 255, 255);
  ttdraw.TextColor = Game.GetColorFromRGB(66, 44, 123);
  ttdraw.TextAlign = eAlignCenter;
  ttdraw.CaretSprite = 29;
  ttdraw.TypeDelayMin = 4;
  ttdraw.TypeDelayMax = 7;
  ttdraw.TypeDelayStyle = eTypedDelay_Mixed;
  ttdraw.CaretFlashOnTime = 9;
  ttdraw.CaretFlashOffTime = 9;
  ttdraw.CaretStyle = eTypedCaret_Explicit;
  ttdraw.TextReadTime = 3;
  
  AudioClip *type_clips[] = new AudioClip[3];
  type_clips[0] = aType;
  type_clips[1] = aType2;
  type_clips[2] = aType3;
  ttdraw.SetRandomTypeSounds(type_clips, 3);
  ttdraw.CaretSound = aCaret;
  
  ttdraw.Start("Thank you Crimson Wizard [ !!!!!!!!!!!");
  AddPage("You are the bestest!!!! THANK YOU!!!!!!!!!!");
  AddPage("Best Module of all time! 700,000 Views Baby!!!");
}

void UpdateTypewriter()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ttdraw.Draw(ds);
    ds.Release();
    //oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
    oPaper.Graphic = papersprite.Graphic;
    Label1.Text = String.Format("ttdraw active: %d, idle %d, wait %d", ttdraw.IsActive, ttdraw.IsIdle, ttdraw.IsWaitingForReader);
  }
  if (ttdraw.IsActive && ttdraw.IsIdle)
  {
    Wait(60);
    ttdraw.Clear();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear(65535);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;
     
    StartTypeNextPage();
  }
}

function room_Load()
{
  paper_original_pos = oPaper.Y;
  cGuybrush.ManualScaling = true;
  cGuybrush.Scaling = 200;
  cGuybrush.FaceLocation(cGuybrush.x + 100, cGuybrush.y, eNoBlock);
}

function oTypewriter_AnyClick()
{
    StartTypewriter();
}

function oPaper_AnyClick()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Skip();
    //oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
  }
}

function room_RepExec()
{
  UpdateTypewriter();
}

I truly appreciate your help Crimson Wizard!

"Thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you, thank you."

-Kielbasa, thanking the DS-86 crew

[TypewriterTextLover]

Hey Crimson Wizard! I'm back with another question! 

I've noticed a potential weird bug with ttdraw.Skip();

If more than ~ 50% of the text has already been typed, and then you try to skip it, the typewriter will just pause and hang instead of displaying the rest of the intended message.

I've looked over the code for ttdraw.Skip which is:

Code: ags

void TypedText::Skip()
{
  this._cur = this._full;
  this._justTyped = false;
  this._hasChanged = true;

Not sure what I could change to fix this problem. Maybe this has something to do with how it calculates split text? Any ideas? Thank you.

Crimson Wizard,

Thank you for the quick reply. Replace the room code with this code to replicate the error. It doesn't happen every time but when the text comes up that says "Best Module of all time! 700,000 Views Baby!!!"
If you try to skip by clicking on the paper between the word "all" and "time" it should hang. It sometimes hangs if you click on the paper right after it types "Crimson" on the first sentence.

Code: ags

// room script file
// Compatibility macros

#ifndef SCRIPT_API_v350
  #define eAlignCenter eAlignCentre
#endif

#define MAX_PAGES 100

String PageStrings[MAX_PAGES];
int TotalPages = 0; // remember how many pages scheduled
int CurrentPage = -1; // remember which is the current page

TypedTextDrawing ttdraw;
DynamicSprite *papersprite;
int paper_original_pos;

function ClearPages()
{
    TotalPages = 0;
    CurrentPage = -1;
}

function AddPage(String text)
{
    if (TotalPages == MAX_PAGES)
        return; // no more place to store pages
    PageStrings[TotalPages] = text;
    TotalPages++;
}

function StartTypeNextPage()
{   if (CurrentPage < TotalPages - 1) // has more pages to display?
    {
        CurrentPage++;
        ttdraw.Start(PageStrings[CurrentPage]);
    }
}

void ClearTypewriter()
{
  if (papersprite != null)
    papersprite.Delete();
  papersprite = null;
  ttdraw.Clear();
  oPaper.Y = paper_original_pos;
}

void StartTypewriter()
{
  ClearTypewriter();
  SayCustom("Launch the big typewriter!");
  
  papersprite = DynamicSprite.CreateFromExistingSprite(28);
  oPaper.Graphic = papersprite.Graphic;
  
  //Display("paper size = %d x %d", papersprite.Width, papersprite.Height);
  ttdraw.X = 4;
  ttdraw.Y = 4;
  ttdraw.Width = papersprite.Width - 8;
  ttdraw.Height = papersprite.Height - 8;
  ttdraw.Font = eFontFont3;
  ttdraw.BkgColor = Game.GetColorFromRGB(255, 255, 255);
  ttdraw.TextColor = Game.GetColorFromRGB(66, 44, 123);
  ttdraw.TextAlign = eAlignCenter;
  ttdraw.CaretSprite = 29;
  ttdraw.TypeDelayMin = 4;
  ttdraw.TypeDelayMax = 7;
  ttdraw.TypeDelayStyle = eTypedDelay_Mixed;
  ttdraw.CaretFlashOnTime = 9;
  ttdraw.CaretFlashOffTime = 9;
  ttdraw.CaretStyle = eTypedCaret_Explicit;
  ttdraw.TextReadTime = 3;
  
  AudioClip *type_clips[] = new AudioClip[3];
  type_clips[0] = aType;
  type_clips[1] = aType2;
  type_clips[2] = aType3;
  ttdraw.SetRandomTypeSounds(type_clips, 3);
  ttdraw.CaretSound = aCaret;
  
  ttdraw.Start("Thank you Crimson Wizard [ !!!!!!!!!!!");
  AddPage("You are the bestest!!!! THANK YOU!!!!!!!!!!");
  AddPage("Best Module of all time! 700,000 Views Baby!!!");
}

void UpdateTypewriter()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ttdraw.Draw(ds);
    ds.Release();
    //oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
    oPaper.Graphic = papersprite.Graphic;
    Label1.Text = String.Format("ttdraw active: %d, idle %d, wait %d", ttdraw.IsActive, ttdraw.IsIdle, ttdraw.IsWaitingForReader);
  }
  if (ttdraw.IsActive && ttdraw.IsIdle)
  {
    Wait(60);
    ttdraw.Clear();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear(65535);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;
     
    StartTypeNextPage();
  }
}

function room_Load()
{
  paper_original_pos = oPaper.Y;
  cGuybrush.ManualScaling = true;
  cGuybrush.Scaling = 200;
  cGuybrush.FaceLocation(cGuybrush.x + 100, cGuybrush.y, eNoBlock);
}

function oTypewriter_AnyClick()
{
    StartTypewriter();
}

function oPaper_AnyClick()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Skip();
    //oPaper.Y = paper_original_pos - ttdraw.LinesDisplayed * (ttdraw.LineHeight + ttdraw.LineSpacing);
  }
}

function room_RepExec()
{
  UpdateTypewriter();
}

[Crimson Wizard]

Replace the room code with this code to replicate the error. It doesn't happen every time but when the text comes up that says "Best Module of all time! 700,000 Views Baby!!!"
If you try to skip by clicking on the paper between the word "all" and "time" it should hang. It sometimes hangs if you click on the paper right after it types "Crimson" on the first sentence.

This is not the module that hangs, it is the Wait(60); command that you have in your script that makes it wait for 1 second before going to the next page.

Skipping makes full text displayed, which also results in Idle state, because it's done typing.
Your own code detects Idle state, waits for 60 ticks, and starts typing next page.

You need to modify your code to let it:
- redraw once more
- maybe wait more before going to the next page after Idle, to let player read the whole page, or wait for another player's clicks, depending on how you want it to be done.

I also recommend to not use Wait() command here, but instead set up a Timer, because Wait suspends all player's interaction.

[TypewriterTextLover]

Crimson Wizard,

I took the Wait(60); out of the demo and it does fix the hanging problem with the text in the demo. It still hangs in my game but only on the last page of text when you try to skip even when I take the Wait(60); out. My code has gotten rather complicated because of one issue:

The typewriter can not seem to interact with inventory items since they are called from the global script and not the room script. To get around this I have have two typewriters going now. One in the room script and one in the global script. I think they are conflicting with each other and causing the hanging problem still. I have looked up importing and exporting to try to call the inventory items from the room script with no luck. Basically what I'm trying to do is if I look at a inventory item, the typewriter will type out a description.

I also have no idea how to get the pages to stop and wait for a mouse click before displaying. I'm going to look into it further and try to mess around with timers although I'd rather have a mouse click to skip text and then wait for user mouse click input again to go to next page.

I'm also using the TUMBLEWEED template which uses a lot of repeatedly executable code which maybe is causing a conflict as well maybe.

I am making a game where it has one central area where all the text is displayed when you look, pickup, etc. All of the text is typewritten like a MacVenture style game.

I appreciate all of your help!

[Crimson Wizard]

It sounds like you need to move all this code to the global script then.
Since it has to be displayed in the same way throughout the game, then it should not be displayed on a room object, but on something else, like a GUI, or screen overlay. Both may have a sprite assigned as a background graphic (check the manual for GUI properties or screen overlays).
I recommend GUI, because it's easier to configure and work with (imho).

I also have no idea how to get the pages to stop and wait for a mouse click before displaying. I'm going to look into it further and try to mess around with timers although I'd rather have a mouse click to skip text and then wait for user mouse click input again to go to next page.

Simplify UpdateTypewriting, you do not need 2 cases, only handle IsActive case:

Code: ags

void UpdateTypewriter()
{
  if (ttdraw.IsActive)
  {
    ttdraw.Tick();
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ttdraw.Draw(ds);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;
  }
  // TEST STRING
  Label1.Text = String.Format("ttdraw active: %d, idle %d, wait %d", ttdraw.IsActive, ttdraw.IsIdle, ttdraw.IsWaitingForReader);
}

Change the Click function to do different things depending on current state:
- if still typing then skip
- if finished typing, then go to next page

Code: ags

function oPaper_AnyClick()
{
  if (ttdraw.IsActive && !ttdraw.IsIdle)
  {
    ttdraw.Skip();
  }
  else if (ttdraw.IsIdle)
  {
    DrawingSurface *ds = papersprite.GetDrawingSurface();
    ds.Clear(65535);
    ds.Release();
    oPaper.Graphic = papersprite.Graphic;
    StartTypeNextPage();
  }
}

Something like that should do it.

[TypewriterTextLover]

I'm having some issues getting the typewriter to work in the global script. I'm not sure what to put in the header and not sure the correct nomenclature for importing functions.
This is what I added to the global header:

Code: ags

import void StartTypewriter();
import function AddPage(String text);
import function ClearPages();
import void PaperLinesShow();
import void PaperLinesHide();

#ifndef SCRIPT_API_v350
  #define eAlignCenter eAlignCentre
#endif

#define MAX_PAGES 100

String PageStrings[MAX_PAGES];
int TotalPages = 0; // remember how many pages scheduled
int CurrentPage = -1; // remember which is the current page

TypedTextDrawing ttdraw;
DynamicSprite *papersprite;
int paper_original_pos;

The typewriter currently shows the first page as being blank. No typewriting sounds. If I click the paper, it will type out the second page.
I'm also not sure what the point of int paper_original_pos and gGuiPaper.Y = paper_original_pos; If I use this line of code it makes my GUI paper appear super high up on the screen. So I put // in front of it.

I think maybe I've written the import Start Typewriter portion wrong.

Thank you for your time Crimson. I'm struggling over here!!     

[Crimson Wizard]

About what to put and not put into the script header:
https://adventuregamestudio.github.io/ags-manual/TheScriptHeader.html

Importing and exporting variables is explained in this topic in the manual:
https://adventuregamestudio.github.io/ags-manual/ImportingFunctionsAndVariables.html

But it seems that you don't need to make any variables public here, they must not be read or set from other place, so you may just hide them inside the script, and have only function "imports" in the header.


I might also recommend not putting this into "globalscript", but make a separate script module for the code related to this "typewriter".


This code has no use at all, this was added to the module's code for compatibility with other versions of AGS:

Code: ags

#ifndef SCRIPT_API_v350
  #define eAlignCenter eAlignCentre
#endif

so you may throw it out.

Throw out any other code that you dont use or which is not working for your case.

[TypewriterTextLover]

Thank you Crimson Wizard! Everything we talked about finally clicked! I have learned a lot and understand modules, importing, where to put variables, simplying code, and I even wrote my own functions today and..... THEY WORKED!!! All of the typewriter text is working perfectly with zero hangups and even controlled completely through mouse clicks that wait on user input in and... IT'S IN IT'S OWN MODULE! THANK YOU!!!!!!!!     

[Crimson Wizard]

I see now that I should have rather made a simpler demo game featuring the most common textbox which prints character speech or game narration.

[TypewriterTextLover]

If you ever update the demo, I think the caret code could be a bit better perhaps. It seems to not work if you use transparent backgrounds like say if you use COLOR_TRANSPARENT, it shows every tick of the caret sprite moving. This forced me to use a single color for the paper instead of a very worn looking detailed paper than I initally planned. I also had to use a smaller caret than I would have liked since the caret in the demo seems to be lower than the text and not evenly centered with the font height. I just altered my sprite a bit to make it center with extra spaces, but that just eats up pixel space I could have used to make the sprite more detailed. I tried messing around with the caret code with no luck.

Just nitpicks though. 700,000 views !!!! 

I also added a FirstPage function that basically replaces the initial ttdraw.

So now if you want to type first page you do FirstPage("text string")
If you want more pages then you use AddPage("text string").

Thank you for everything!