View source for UFO-Scripts/seq *.ufo

A sequence is a cinematic using the game engine to render 3D models, image, text, sounds, and music. It can be displayed in fullscreen, or as a part or the GUI.

With this type of UFO-script we can make your own sequences. Have a look at the '''base/ufos/seq_*.ufo''' for more examples.

==<code>precache [model|pics]</code>==
* .. for <code>models</code> as parameter:	pathnames relative from {{path|base}}-folder
* .. for <code>pics</code> as parameter:	pathnames relative from {{path|base/pics}}-folder
* .. (string)	filenames for {{path|models/pics}}
===Example===
<pre>
precache models
{
	"models/civilians/male/body01"
	"models/civilians/male/head01"
}
precache pics
{
	ufoai
}
</pre>

==<code>camera NAME</code>==
* '''omega''': [[V_VECTOR]] 
: moving
* '''zoom''': [[V_FLOAT]] 
: value for zooming
* '''dist''': [[V_INT]]
: 
* '''origin''': [[V_VECTOR]] 
: where does it start?
* '''angles''': [[V_VECTOR]] 
: rotation

===Example===
<pre>
camera cam1
{
	zoom	1.0
	angles	"30 225 0"
	dist	100
}
</pre>

==<code>obj2d NAME</code>==
* '''text''': [[V_TRANSLATION_MANUAL_STRING]]
: the translateable text
* '''pos''': [[V_POS]]
: x, y (normalized to 1024x768 resolution)
* '''align''': [[V_ALIGN]]
: ur, ul, uc, ...
* '''color''': [[V_COLOR]]
: The RGBA value for the obj2d
* '''fade''': [[V_COLOR]]
: RGBA
* '''speed''': [[V_POS]]
: speed in two directions (x,y)
* '''relative''': [[V_BOOL]]
: will be placed relative to previous element - useful if you use translateable text and don't know for sure how many lines the translated text uses
* '''enlarge''': [[V_POS]]
: value used for scaling the obj2d
* '''bgcolor''': [[V_COLOR]]
: the RGBA value for the background color
* '''font''': [[V_STRING]]
: the font that should be used to display the text (see [[UFO-Scripts/fonts.ufo|font definitions]])
* '''image''': [[V_STRING]]
: the image path - relative to {{path|base/pics}}
* '''name''': [[V_STRING]]
:
* '''inbackground''': [[V_BOOL]]
: If true, the engine render the object before the 3D models. Default value is false.

===Example===
<pre>
obj2d herby_text
{
	text	"Code, Visual Effects"
	pos	"974 50"
	align	ur
	color	"0 1 0 0"
	fade	"0 0 0 1"
}
</pre>

==<code>model NAME</code>==
* '''tag''': [[V_STRING]]
: 
* '''anim''': [[V_STRING]] 
: see anm-file for model
* '''skin''': [[V_INT]] 
: skinnumber
* '''parent''': [[V_STRING]] 
: parent model (e.g. head and body) (at head: name of the body-model)
* '''speed''': [[V_VECTOR]] 
: speed in all three directions (x,y,z)
* '''omega''': [[V_VECTOR]] 
: moving
* '''origin''': [[V_VECTOR]] 
: where does it start?
* '''angles''': [[V_VECTOR]] 
: rotation

===Example===
<pre>
model herby_body
{
	model	models/civilians/male/body01.md2
	skin	2
	anim	walk0
	origin	"-277.5 0 0"
	speed	"60 0 0"
}
model herby_head
{
	model	models/civilians/male/head01.md2
	parent	herby_body
	tag	tag_head
}
</pre>

==General commands==
* '''wait''': [[V_FLOAT]] 
: value of seconds to wait
* '''cmd''': [[V_STRING]] 
: command to execute
* '''rem''': see <code>delete</code>
* '''delete''': [[V_STRING]]
: remove a ressource - string is the NAME of the ressource to remove
* '''animspeed''': [[V_INT]] 
: set the speed used for animation of models. The default value is 1000 milliseconds. A smaller value will set a slower animation.
* '''click'''
:Will halt the sequence execution until the user clicked a mouse button
* '''sound''' NAME
:NAME is a soundfile relative to the {{path|sounds}} directory.
* '''music''' NAME
:NAME is a musicfile relative to the {{path|music}} directory.

===Example===
<pre>
wait 0.2
delete herby_body
delete herby_head
delete herby_text
</pre>

==Example==
<pre>
sequence intro
{
	music mission
	animspeed 100

	obj2d i_sentence1
	{
		text	"_intro_sentence1"
		pos		"512 485"		align	uc
		color	"0 1 0 1"
		speed	"0 -30"
		relative	true
	}
	obj2d i_sentence2
	{
		text	"_intro_sentence2"
		pos		"512 510"		align	uc
		color	"0 1 0 1"
		speed	"0 -30"
		relative	true
	}
	obj2d i_sentence3
	{
		text	"_intro_sentence3"
		pos		"512 535"		align	uc
		color	"0 1 0 1"
		speed	"0 -30"
		relative	true
	}
	obj2d i_sentence4
	{
		text	"_intro_sentence4"
		pos		"512 560"		align	uc
		color	"0 1 0 1"
		speed	"0 -30"
		relative	true
	}
	obj2d i_sentence5
	{
		text	"_intro_sentence5"
		pos		"512 585"		align	uc
		color	"0 1 0 1"
		speed	"0 -30"
		relative	true
	}
	wait 200.0

	delete i_sentence1
	delete i_sentence2
	delete i_sentence3
	delete i_sentence4
	delete i_sentence5
}
</pre>

==Tool==
The command <code>seq_start</code> allow to display a random sequence in fullscreen.

Open the console and type:
<pre>
seq_start NAME_OF_THE_SEQUENCE
</pre>

[[Category:Contribute]]
[[Category:UFO-Scripts]]