boatem.html from POL-distro scripts at Krugle

Show boatem.html syntax highlighted

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
0049)fullfunc.html?xmlfile=boatem -->
<HTML><HEAD><TITLE>POL Scripting Reference</TITLE>
<META http-equiv=Content-Type content="text/html; charset=windows-1252">
<META content="POL, EScript, documentation" name=keyword>
<META content="Racalac, Rykard" name=Author>
<META content="MSHTML 6.00.2800.1126" name=GENERATOR>
<STYLE type=text/css>BODY {
	FONT-WEIGHT: normal; FONT-SIZE: 8pt; COLOR: #000000; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif
}
TD {
	FONT-WEIGHT: normal; FONT-SIZE: 8pt; COLOR: #000000; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif
}
P {
	FONT-WEIGHT: normal; FONT-SIZE: 8pt; COLOR: #000000; FONT-FAMILY: Verdana, Arial, Helvetica, sans-serif
}
</STYLE>
</HEAD>
<BODY bgColor=#f0f0f0><?xml version="1.0" encoding="UTF-8"?>
<P style="FONT-WEIGHT: bold; FONT-SIZE: 14pt; TEXT-ALIGN: left">File: 
Boat.em</P>
<P style="FONT-WEIGHT: bold; FONT-SIZE: 10pt; TEXT-ALIGN: left">Description: 
Functions for manipulating Multi Boat objects.<BR>Last Modified: 3/27/2003</P>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#BoatFromItem>
    <TH align=middle colSpan=2>BoatFromItem( item )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>item</VAR></TD>
    <TD>Item Ref</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>if you have an itemref referring to a boat (typically in a 
      doubleclick script) this will convert it into a boatref.</TD></TR>
  <TR>
    <TD colSpan=2>Note that this should not be necessary 
anymore.</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Boat Reference</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>"Item wasn't a multi"</TD></TR>
  <TR>
    <TD colSpan=2>"Multi wasn't a boat"</TD></TR>
  <TR>
    <TD colSpan=2>"Invalid parameter type."</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Item"><B>Item</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#MoveBoat>
    <TH align=middle colSpan=2>MoveBoat( boat, facing )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>boat</VAR></TD>
    <TD>Boat Reference</TD></TR>
  <TR>
    <TD width="50%"><VAR>facing</VAR></TD>
    <TD>Integer (0..7)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Moves a boat in the direction of an absolute facing</TD></TR>
  <TR>
    <TD colSpan=2>0=N, 1=NE, 2=E, 3=SE, 4=S, 5=SW, 6=W, 7=NW</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>1 always</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>none (returns 0 on invalid param)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#MoveBoatRelative>
    <TH align=middle colSpan=2>MoveBoatRelative( boat, direction 
  )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>boat</VAR></TD>
    <TD>Boat Reference</TD></TR>
  <TR>
    <TD width="50%"><VAR>facing</VAR></TD>
    <TD>Integer (0..7)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Move a boat in the direction of a relative facing. Same as 
      MoveBoat, but adjusted for boat's facing.</TD></TR>
  <TR>
    <TD colSpan=2>If boat faces East, 0 will move E, 1 will move SE, 
  etc.</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>1 always</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>none (returns 0 on invalid param)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#MoveBoatXY>
    <TH align=middle colSpan=2>MoveBoatXY( boat, x, y )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>boat</VAR></TD>
    <TD>Boat Reference</TD></TR>
  <TR>
    <TD width="50%"><VAR>x</VAR></TD>
    <TD>Integer world coordinate</TD></TR>
  <TR>
    <TD width="50%"><VAR>y</VAR></TD>
    <TD>Integer world coordinate</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Moves a boat to the specified world coordinates.</TD></TR>
  <TR>
    <TD colSpan=2>Careful moving close to the world edge where a part of the 
      boat might be out of bounds.</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>1 on success, 0 on failure</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Invalid Parameter</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#RegisterItemWithBoat>
    <TH align=middle colSpan=2>RegisterItemWithBoat( boat, item 
  )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>boat</VAR></TD>
    <TD>Boat Reference</TD></TR>
  <TR>
    <TD width="50%"><VAR>item</VAR></TD>
    <TD>Item Reference)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>'registering' an item with a boat causes the boat to move 
      the item when it moves, if and only if the item is still on the 
  boat.</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>1 always</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>none (returns 0 on invalid param)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Item"><B>Item</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#SystemFindBoatBySerial>
    <TH align=middle colSpan=2>SystemFindBoatBySerial( serial 
  )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>serial</VAR></TD>
    <TD>Integer</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>given the serial number of a boat, return a boatref that can 
      be used with MoveBoat, TurnBoat, etc.</TD></TR>
  <TR>
    <TD colSpan=2>SystemFindObjectBySerial can find boats as well, should use 
      that.</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Boat Reference on success</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>"Boat not found."</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<TABLE cellSpacing=0 cellPadding=1 rules=groups width="75%" align=center 
bgColor=#dddddd border=1 frame=box>
  <TBODY>
  <TR><A name=#TurnBoat>
    <TH align=middle colSpan=2>TurnBoat( boat, direction )</TH></A></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Parameters:</TH></TR></TBODY>
  <TBODY>
  <TR bgColor=#d4d4d4>
    <TD>Name</TD>
    <TD>Type</TD></TR></TBODY>
  <TBODY>
  <TR>
    <TD width="50%"><VAR>boat</VAR></TD>
    <TD>Boat Reference</TD></TR>
  <TR>
    <TD width="50%"><VAR>direction</VAR></TD>
    <TD>Integer (0..3)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Explanation</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>Turn a boat in a direction, relative to its current 
    directon.</TD></TR>
  <TR>
    <TD colSpan=2>direction is 0=none, 1=right, 2=flip, 3=left</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Return values</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>true/false if the boat could be turned (i.e. wouldn't be in 
      an invalid location after the turn)</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Errors</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2>"Invalid Parameter type"</TD></TR></TBODY>
  <TBODY>
  <TR bgColor=#cccccc>
    <TH align=left colSpan=2>Related</TH></TR></TBODY>
  <TBODY>
  <TR>
    <TD colSpan=2><A 
      href="objref.html#Boat"><B>Boat</B></A></TD></TR></TBODY></TABLE><BR><BR><BR>
<HR>

<P style="FONT-WEIGHT: bold; FONT-SIZE: 9pt; TEXT-ALIGN: center">If you know if 
any information is incorrect on these pages, mail your corrections to 
racalac@burdell.org </P>
<P style="FONT-WEIGHT: bold; FONT-SIZE: 7pt; TEXT-ALIGN: center">Copyright ©2003 
David Carpman, all rights reserved. DO NOT REPRODUCE, MIRROR, ALTER, SPINDLE, 
MUTILATE, OR SIT ON. </P></BODY></HTML>
See more files for this project here