Just to elaborate on my last post, here's a simple example of a scripted message.
First you create a layout file for the message (I've done it manually but you can use the CEGUI layout editor for this task):
Code: Select all
<?xml version="1.0" encoding="UTF-8"?>
<GUILayout >
<Window Type="TaharezLook/FrameWindow" Name="Message/Scripted/Window">
<Property Name="UnifiedPosition" Value="{{0.3,0},{0.15,0}}" />
<Property Name="UnifiedMaxSize" Value="{{0.5,0},{0.5,0}}" />
<Property Name="UnifiedMinSize" Value="{{0,128},{0,128}}" />
<Property Name="UnifiedSize" Value="{{0.4,0},{0.3,0}}" />
<Property Name="Text" Value="Message Window" />
<Event Name="Shown" Function="Message_OnShown" />
<Event Name="CloseClicked" Function="Message_OnCloseClicked" />
<Window Type="TaharezLook/StaticText" Name="Message/Scripted/Text" >
<Property Name="TextColours" Value="tl:FF648CDC tr:FF648CDC bl:FF648CDC br:FF648CDC" />
<Property Name="FrameEnabled" Value="False" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.1,0},{0.1,0},{0.9,0},{0.8,0}}" />
<Property Name="BackgroundEnabled" Value="False" />
<Property Name="HorzFormatting" Value="WordWrapCentred" />
</Window>
<Window Type="TaharezLook/Button" Name="Message/Scripted/Close" >
<Property Name="Text" Value="Close" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedAreaRect" Value="{{0.6,0},{0.75,0},{0.9,0},{0.9,0}}" />
<Property Name="Tooltip" Value="Click to close message window" />
<Event Name="Clicked" Function="Message_OnCloseClicked" />
</Window>
</Window>
</GUILayout>
This is a simple window with 2 children, namely a static text window (which actually receives the message text) and a button to close the window. Besides the property definitions like the window size, the event attributes may have caught your attention. These attributes actually connect events with script methods.
Before we get to the script, let's make this layout available for message entities. To do this we are using the message.ini file as in earlier RF versions, however the definition looks different now:
Code: Select all
[Scripted]
layout = message_scripted.layout
textwindow = Message/Scripted/Text
script = message.s
Here we specify the layout file (the one above), the window that will receive the message text and the script that will handle events from the message window.
And this brings us to the actual script
Code: Select all
{
Message_OnShown[(e)
{
DialogState.UpdateLevel(false);
DialogState.RenderLevel(true); // default
DialogState.Enter();
Log.SetFile("message_script.log"); // open log file
Log.SetPriority(Log.DEBUG); // set output level
Log.Print("Log.Print");
Log.Debug("Log.Debug");
Log.Info("Log.Info");
Log.Notice("Log.Notice");
Log.Warning("Log.Warning");
//Log.Error("Log.Error");
//Log.Critical("Log.Critical");
Log.Log(Log.DEBUG, "Log.Log");
// iterate over all loaded fonts and print their heights
for each font in GUI.FontManager
{
Log.Print("font height " # toString(font.getFontHeight()));
}
Log.SetFile("RealityFactory.log"); // reset log file to default
}]
Message_OnCloseClicked[(e)
{
DialogState.Exit();
}]
}
Message_OnShown gets called when the message entity gets activated and the layout is shown. Right at the start of this method we change into DialogState which restricts user interaction to the GUI. You can choose whether the level should continue to run during this state or time will be frozen (DialogState.UpdateLevel). Also rendering the level is optional in this state (DialogState.RenderLevel).
Next in this method is a test of various Log functions, which produce the following output in the file message_script.log
Code: Select all
Log.Print
[debug] Log.Debug
[info] Log.Info
[notice] Log.Notice
[warning] Log.Warning
[debug] Log.Log
font height 14.493395
Also demonstrated in this method is a nifty little feature of Simkin that let's you iterate over a set of values in custom objects in a 'for each' statement (provided you wrote the corresponding iterator class). In this example we run through all fonts loaded in the FontManager and print their height to the log file.
Message_OnCloseClicked gets called when we click the Close button. Here we just switch back to the normal play state.
