Added add-objective and remove-objective

This commit is contained in:
jsalmon3 2002-09-26 21:09:53 +00:00
parent 6b6f16cfe7
commit 446b940776
2 changed files with 70 additions and 7 deletions

View file

@ -45,6 +45,7 @@
<HR>
<A HREF="#add-keystroke-help">add-keystroke-help</A>
<A HREF="#add-message">add-message</A>
<A HREF="#add-objective">add-objective</A>
<A HREF="#add-tip">add-tip</A>
<A HREF="#briefing">briefing</A>
<A HREF="#create-unit">create-unit</A>
@ -76,6 +77,7 @@
<A HREF="#pf-show-regids!">pf-show-regids!</A>
<A HREF="#place-unit">place-unit</A>
<A HREF="#player">player</A>
<A HREF="#remove-objective">remove-objective</A>
<A HREF="#replay-log">replay-log</A>
<A HREF="#reset-keystroke-help">reset-keystroke-help</A>
<A HREF="#selection">selection</A>
@ -151,34 +153,65 @@ Everything around the game.
<A HREF="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </A>
<A NAME="add-objective"></A>
<H3>add-objective</H3>
<H4>Description</H4>
Add an objective to the scenario objectives text list.
<H4>Syntax</H4>
<CODE>(add-objective objective position)</CODE>
<DL>
<DT>objective</DT>
<DD>Objective text.
</DD>
<DT>position</DT>
<DD>Optional position (0 offset) to add the objective, default is at the end.
</DL>
<H4>Example</H4>
<PRE>
(add-objective "-Build a barracks")
(add-objective "-Destroy all enemies" 0)
</PRE>
<P>Adds the objective text "-Build a barracks" to the end of the objectives
list and adds the objective "-Destroy all enemies" to the first position.
<H4>Not Used</H4>
<A NAME="add-tip"></A>
<H3>add-tip</H3>
<H4>Description</H4>
.
Adds a tip. Tips are shown at the start of a level.
<H4>Syntax</H4>
<CODE>(add-tip)</CODE>
<CODE>(add-tip tip)</CODE>
<DL>
<DT></DT>
<DD>.
<DT>tip</DT>
<DD>Text of the tip.
</DD>
</DL>
<H4>Example</H4>
<PRE>
(add-tip)
(add-tip "You can demolish trees and rocks.")
</PRE>
<P>.
<P>Adds the tip.
<H4>Used</H4>
<A HREF="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </A>
<A HREF="../../data/ccl/tips.ccl"> $LIBARYPATH/ccl/tips.ccl </A>
<A NAME="briefing"></A>
<H3>briefing</H3>
@ -1048,6 +1081,32 @@ Returns the current game cycle.
<A HREF="../../data/ccl/wc2.ccl"> $LIBARYPATH/ccl/wc2.ccl </A>
<A NAME="remove-objective"></A>
<H3>remove-objective</H3>
<H4>Description</H4>
Remove an objective from the scenario objectives text list.
<H4>Syntax</H4>
<CODE>(remove-objective position)</CODE>
<DL>
<DT>position</DT>
<DD>Position (0 offset) to remove from the objectives list.
</DL>
<H4>Example</H4>
<PRE>
(remove-objective 0)
</PRE>
<P>Remove the first objective from the objectives list.
<H4>Not Used</H4>
<A NAME="replay-log"></A>
<H3>replay-log</H3>

View file

@ -76,6 +76,8 @@
<DD></DD>
<DT><A HREF="game.html#add-message">add-message</A></DT>
<DD></DD>
<DT><A HREF="game.html#add-objective">add-objective</A></DT>
<DD></DD>
<DT><A HREF="game.html#add-tip">add-tip</A></DT>
<DD></DD>
<DT><A HREF="triggers.html#add-trigger">add-trigger</A></DT>
@ -320,6 +322,8 @@
<DD></DD>
<DT><A HREF="ui.html#process-menu">process-menu</A></DT>
<DD></DD>
<DT><A HREF="game.html#remove-objective">remove-objective</A></DT>
<DD></DD>
<DT><A HREF="game.html#replay-log">replay-log</A></DT>
<DD></DD>
<DT><A HREF="game.html#reset-keystroke-help">reset-keystroke-help</A></DT>