SSH Productions: Module documentation for GuiPortrait.zip

Module: GuiPortrait 1.00, by SSH

Display Sierra-style speech portraits on a GUI

Download GuiPortrait as a zip file

Author

Andrew MacCormack (SSH)

Please use the messaging function on the AGS forums to contact

me about problems with this module

Abstract

Work around AGS problem that the Sierra-style portrait appears

behind GUIs instead of in-front, by making it appear on a GUI.

Dependencies

AGS 3.02 or later, but may work with earlier versions

Functions

Character.GSay(String what, optional int view, optional int loop)

Says the text "what", with portrait on a GUI. Can also specify a

view, or view and loop, if you like, to use that view/loop for this

text only.

Configuration

To select the GUI used for portraits, either just call it gPortrait and

it wil be found automatically, or add Portrait_GUI=gMYGUI to your global

script game_start function.

To change the position of the portraits, you can adjust the variables

Portrait_Left_Indent, Portrait_Right_Indent and Portrait_Sierra_Y

although their default positions seem to match AGS's

Set Portrait_AutoFlip if you want the portaits to automatically flip

when they are on the left rather than the right. NB: This only works if

your view doesn't have transparency.

Example

  // Say some stuff:
  player.GSay("Read my lips... if you can!")

Caveats

Lip-synch not supported

Thinking views not supported

Revision History

1 Jul 08: v1.0 First release of GuiPortrait module

Licence

GuiPortrait AGS script module

Copyright (C) 2008 Andrew MacCormack

This module is licenced under the Creative Commons Attribution Share-alike

licence, (see http://creativecommons.org/licenses/by-sa/2.5/scotland/ )

which basically means do what you like as long as you credit me and don't

start selling modified copies of this module.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

DEALINGS IN THE SOFTWARE.

In addition to the licences mentioned in the modules themselves, you may choose to use the following creative commons licence if you prefer for all AGS modules and open source code resources on my site.

Creative Commons License
This work is licenced under a Creative Commons Licence.