Island Anims - Care and feeding: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Link to "FDF" and external link to PMC-VTE)
m (To be continued)
Line 1: Line 1:
[[Category:Operation Flashpoint: Modelling]]
<big>Care and feeding of Island Animations</big>


<big>Care and feeding of Island Animations</big>
==What it is==
==Caveat==
Not sure at this time if this still applies to ArmA.


==What Is It?==
Island animations are cutscenes that are loaded in the main menu. There is a specific island and its cutscene(s) loaded by default. Via the [[ArmA:_Startup_Parameters]] -world can set a different island or none as default.
Island animations are the cutscenes that are invoked when you EXIT a mission. They display in the background to the main ofp panel. Each Island, has one (or several). The engine expects to find one to display and you are often presented with either a black screen, or, continuing game play, even though you exited the mission, when they are located in the wrong place. ie, missing,


==The problem==
If you load a different island for a SP/MP mission or in the editor, and return to the main menu, you will see the cutscene(s) for the island, that was active last.
All Island anims must go into the official ~\Addons folder ''irrespective of using mod folders or not.''


==The Cause==
If the screen remains black or the last mission continues / is active in the background, the currently active island's cutscene(s) are broken or not present.
As ever increasing numbers of addons (and islands) have been constructed over the years, it is impractical, and very inadvisable, to keep stuffing  them into  the 'official' folders of ~\Addons and / or ~\Res\Addons.  In fact, the release of OFP: Resistance introduced the whole idea of using a mod folder for addons. The resistance pack IS a mod folder, only an 'official' one.


Nowadays, the correct approach is to separate out addons into folders of related material (HYK, BAS, LSR, Nam) and use Kegety's excellent launcher to simply select those addons needed for the specific mission/campaign at hand. This article does not discuss the merits of doing this, it should, be obvious. If it weren't, you wouldn't be reading!
==Create main menu cutscenes==


One wrinkle remains however with Island Anims. They cannot be inside a pbo. Neither their own, nor any other. This then prevents relative references being made to them. They must be hard wired to a known folder.
===Config definition===


So the standard approach is to place them in the official ~\Addons folder. Note carefully, not, the ~\Res\Addons folder (it might not exist!). This is a design decision implmemented by the author of the island addon. You, have no say in the matter.
===Building a cutscene mission===


All of which contradicts the purpose of mods folders in attempting to keep your installation 'clean'.
===Cutscene mission location===


==The cure==
===For Players===
there isn't one. Except to say, wherever you've been in doubt before, place the island anim folder in the root Addons directory. It is, the only place it will work. Note, you dont need (and shouldn't) put the <u>island</u> addon in here despite the readme.txt that says to do so. Addons belong in mods folders. Period. But, you '''must''' place the anim in here.


===For Authors and Hackers.===
==OFP specifics==
If you look a little closer, a mods directory is actually a mods folder with an embedded addons directory.


Since it's your island, you can be pretty specific on what to call the mods name. In otherwords, you can, dictate the label.
All Island anims must go into the official .\OFP\Addons folder ''irrespective of using mod folders or not.''


Let's take Doe's Winter Everon for example.
A cutscene mission is to be called ''islandName_anim\intro'' and must remain a folder.  


Doe1.pbo is a classic Island pbo. it contains a wrp (island texture) file, a config.cpp, and lots of pretty pictures. The config.cpp for this island addon, and any other island addon out there, specifies where to find the island anim.
They cannot be packed inside a pbo.


Unsurprisingly, you will discover this
====Absolute path definition====


  class CfgWorlds
  cutscenes[]={"..\adddons\islandName_anim\intro"};
{
  class DefaultWorld {};
  class DOEeden_snow: DefaultWorld
  {
    ......
    cutscenes[]={"..\ADDONS\doe1_anim\intro"};


In otherwords, this island pbo conforms to the standard, hardwired convention, of placing the island anim in the root Addons folder.  
In otherwords, this island pbo conforms to the standard, hardwired convention, of placing the island anim in the root Addons folder.  
Line 56: Line 41:


From now on, you, and players, can use the anim in a 'standard' mod folder, called, WinterEveron.
From now on, you, and players, can use the anim in a 'standard' mod folder, called, WinterEveron.
The above is the base principle of so-called full modification mods. Mods like @Farmland and [[Finnish Defence Forces Mod]] (FDF) and [http://flashpoint.nekromantix.com/vte.php PMC-VTE] conform exactly to the manner described above.

Revision as of 15:37, 13 March 2009

Care and feeding of Island Animations

What it is

Island animations are cutscenes that are loaded in the main menu. There is a specific island and its cutscene(s) loaded by default. Via the ArmA:_Startup_Parameters -world can set a different island or none as default.

If you load a different island for a SP/MP mission or in the editor, and return to the main menu, you will see the cutscene(s) for the island, that was active last.

If the screen remains black or the last mission continues / is active in the background, the currently active island's cutscene(s) are broken or not present.

Create main menu cutscenes

Config definition

Building a cutscene mission

Cutscene mission location

OFP specifics

All Island anims must go into the official .\OFP\Addons folder irrespective of using mod folders or not.

A cutscene mission is to be called islandName_anim\intro and must remain a folder.

They cannot be packed inside a pbo.

Absolute path definition

cutscenes[]={"..\adddons\islandName_anim\intro"};

In otherwords, this island pbo conforms to the standard, hardwired convention, of placing the island anim in the root Addons folder.

However, how about this

   cutscenes[]={"..\WinterEveron\ADDONS\doe1_anim\intro"};

What you are saying here is you have created a mod which MUST be called WinterEveron (hardly an illogical choice, and hardly likely to collide with other folder names!)

The island pbo, will call the anim in the same folder as the pbo. This is, after all how you shipped your island in a zip file in the first place!

From now on, you, and players, can use the anim in a 'standard' mod folder, called, WinterEveron.