i've just realised i didn't include any instructions with it... duh...
**********************************************
<b><span style='`font-size`:21pt;`line-height`:100%'>instructions for players</span></b>
it's really simple <img src="http://www.piratesahoy.com/forum/style_emoticons/<#EMO_DIR#>/happy.gif" style="vertical-align:middle" emoid="^_^" border="0" alt="happy.gif" /> the 'choose sail' interface is now very much improved. you can select the type of sail (whole or torn), the colour (white, crimson or black) and the design, without having to scroll through loads of images. you can also see all the images, even custom ones, on the interface.
remember that when you set your sails, the new sails won't be displayed until the next time you go to the sea/battle screen.
the interface now supports bought sails. currently there are no buyable sails available in the game, but in future mods this could change!
**********************************************
<b><span style='`font-size`:21pt;`line-height`:100%'>instructions for modders</span></b>
<b>custom sails</b>
you should NOT have to do any modding to the program itself! please don't change the interface files, or procGetSailTextureData!
all you have to do to make new custom sails available is:
- place the file in RESOURCETexturesShips
- name it:
- sail_whole_white_pirate?.tga.tx - if it's a whole white sail
- sail_torn_white_pirate?.tga.tx - if it's a torn white sail
- sail_whole_red_pirate?.tga.tx - if it's a whole red sail
- sail_torn_red_pirate?.tga.tx - if it's a torn red sail
- sail_whole_black_pirate?.tga.tx - if it's a whole black sail
- sail_torn_black_pirate?.tga.tx - if it's a torn black sail
- the ? in that filename represents the sail number. you must use the <b>next available</b> sail number. for example, if you want to add a torn white sail, and the last used one is sail_whole_white_pirate22.tga.tx, yours <b>must</b> be sail_whole_white_pirate23.tga.tx. (or, if you prefer, you can swap it with one of the existing files and rename <i>that</i> file sail_whole_white_pirate23.tga.tx).
- in buildsettings.h, go to the custom sail section near the bottom of the file, and increase the appropriate value by 1. the number in buildsettings.h should always be <b>one higher</b> than the last used sail number. therefore, continuing our example, if you've just added sail_whole_white_pirate23.tga.tx, the value in buildsettings.h for whole white sails should be 24.
<b>buyable sails</b>
you should NOT have to do any modding to the program itself! please don't change the interface files, or procGetSailTextureData!
this mod doesn't include any sort of system or interface for organising sails that the user is <i>allowed</i> to buy. (modders can do that if and when it is necessary <img src="http://www.piratesahoy.com/forum/style_emoticons/<#EMO_DIR#>/happy.gif" style="vertical-align:middle" emoid="^_^" border="0" alt="happy.gif" /> ) it only contains the system for actually <i>adding</i> the sail to the player once it's been bought. the player may then select it via the f2 interface.
to add a buyable sail to the player (i.e. when the player has just bought it), use the function <b>KAM_BuySail</b>. you could call this function in a dialogue node, for example.
this function doesn't deal with taking money off the player. it just adds the buyable sail to the player's list of bought sails, so they can then select it from the f2 menu.
it has five arguments:
- sail id. this is never displayed to the user. it is used to identify the sail internally.
- second argument: string: the full path of the emblemed sail texture file. it should start with "Ships" (assuming that's where you put the texture) and end in ".tga"
- third argument: string: the full path of the `non-emblemed` sail texture file. it should start with "Ships" (assuming that's where you put the texture) and end in ".tga"
- fourth argument: string: a short description of the sail, displayed to the user on the f2 screen when they want to select the sail. don't make it too long or it won't fit on the screen <img src="http://www.piratesahoy.com/forum/style_emoticons/<#EMO_DIR#>/happy.gif" style="vertical-align:middle" emoid="^_^" border="0" alt="happy.gif" />
- fifth argument: true or false: set to 'true' to activate the sails straight away, or set to 'false' to just add them, so the player can select them later.
so for example, using alan's idea of sails buyable from a curio shop on redmond, he might add to one of the dialogue nodes of his storekeeper (AFTER money has been checked and taken from the player):
<b>KAM_BuySail("AlansCurioSails","Shipsalans_curio_sails_emblemed.tga","Shipsalans_curio_sails_nonemblemed.tga","Sails made from human flesh! Bought from the Curio shop on Redmond.",true);</b>
in your interface or dialogue you might want to check if the player has already bought a sail. use the <b>KAM_SailHasBeenBought</b> function. all you need to supply is the sail id. the function returns true or false.
so for example, in alan's storekeeper's dialogue, we might have an `if-statement` that used that function:
<b>if (KAM_SailHasBeenBought("AlansCurioSails") == false)
{
link.l1 = "We have some wonderful sails made from human flesh!";
link.l1.go = "buyhumanfleshsails";
}</b>
that node would only appear if the sails with id "AlansCurioSails" had NOT been bought.
if you want to know how many buyable sails the player has bought, check the property <b>PChar.BuyableSails.Qty</b>, where PChar is the main character.
if you want to do calculations with this number you'll probably want to get the number this way: <b>sti(PChar.BuyableSails.Qty)</b>
if you want to know what number in the player's list a particular sail is, call the function KAM_GetSailIndex; again all you need to supply is the sail id of the sail you're looking for.
the function returns the number of the sail in the player's list (nb. the list starts with the number 0), or -1 if the sail has not been bought.
so for example, if you want to know where alan's sails are in the player's list, call <b>KAM_GetSailIndex("AlansCurioSails")</b>. the returned value would be 0 if alan's sails were the first set of buyable sails that the player had bought; 1 if they were the second set of buyable sails that the player had bought; etc.
**********************************************
whew <img src="http://www.piratesahoy.com/forum/style_emoticons/<#EMO_DIR#>/happy.gif" style="vertical-align:middle" emoid="^_^" border="0" alt="happy.gif" />
if anyone has any doubts, just ask!
" border="0" alt="icon_praise.gif" /> Thanks mate!!!!!
" border="0" alt="par-ty.gif" />
ahoy@ftp.piratesahoy.net/" target="_blank">ftp://files%40piratesahoy.net
" border="0" alt="icon_mrgreen1.gif" />