function list

[Betelgeuse]

Name:
shpIsRadiationImmune

Syntax:
(shpIsRadiationImmune ship [itemListCursor])

Argument List:
ship: The ship that you want check if it is radiation immune.
itemListCursor: The optional location of the armor to check.

Returns:
condition: True if the armor pointed too compatible with the ship, if no armor is pointed to checks all the armor and if all are immune returns True, Nil otherwise.

Category:
ship, condition query

Description:
Checks to see if the ship is radiation immune.

Example:

Comment:
Basic query function to check if a ship is radiation immune.

[Betelgeuse]

Name:
shpIsRadioactive

Syntax:
(shpIsRadioactive ship)

Argument List:
ship: The ship that you want check if it is radioactive.

Returns:
condition: True if the ship is radioactive, Nil otherwise.

Category:
ship, condition query

Description:
Checks to see if the ship is radioactive.

Example:

Code: Select all

(shpIsRadioactive gplayership)

Checks to see if the player's ship is radioactive and returns the result.

Comment:
Basic query function to check if a ship is radioactive.

[Betelgeuse]

Name:
shpIsSRSEnhanced

Syntax:
(shpIsSRSEnhanced ship)

Argument List:
ship: The ship that you want check if it's SRS is enhanced.

Returns:
condition: True if the ship's SRS is enhanced, Nil otherwise.

Category:
ship, condition query

Description:
Checks to see if the ship's SRS is enhanced.

Example:

Code: Select all

(shpIsSRSEnhanced gplayership)

Checks to see if the player's ship's SRS is enhanced and returns the result.

Comment:
Basic query function to check if a ship's SRS is enhanced.

[Betelgeuse]

Name:
shpIsTargetingComputerInstalled

Syntax:
(shpIsTargetingComputerInstalled ship)

Argument List:
ship: The ship that you want check if it's targeting computer is installed.

Returns:
condition: True if the ship's targeting computer is installed, Nil otherwise.

Category:
ship, condition query

Description:
Checks to see if the ship's targeting computer is installed.

Example:

Code: Select all

(shpIsTargetingComputerInstalled gplayership)

Checks to see if the player's ship's targeting computer is installed and returns the result.

Comment:
Basic query function to check if a ship's targeting computer is installed.

[Betelgeuse]

Name:
shpMakeBlind

Syntax:
(shpMakeBlind ship number)

Argument List:
ship: The ship that you want to make blind.
number: How long in ticks you want to make the ship blind.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, damage/repair

Description:
Makes the ship blind for the given number of ticks.

Example:

Code: Select all

(shpMakeBlind gplayership 300)

Makes the player blind for 300 ticks.

Comment:
Interesting function allowing you to give a punishment.

[Betelgeuse]

Name:
shpMakeRadioactive

Syntax:
(shpMakeRadioactive ship)

Argument List:
ship: The ship that you want to make radioactive.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, radiation

Description:
Makes the ship radioactive.

Example:

Code: Select all

(shpMakeRadioactive gplayership)

Makes the player's ship radioactive.

Comment:
Interesting function allowing you to give a punishment.

[Betelgeuse]

Name:
shpOrder

Syntax:
(shpOrder ship string [expression]^1)

Argument List:
ship: The ship that you want to order.
string: A string representing the order.
expression: The optional arguments if needed by the order.
^1

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order.

Example:

Code: Select all

(shpOrder gPlayerShip 'wait)

Returns True, ordering the player to wait doesn't do much.

Comment:
Allows you to give orders to ships, interesting because you can easily vary the orders.

[Betelgeuse]

Name:
shpOrderAttack

Syntax:
(shpOrderAttack ship ship)

Argument List:
ship: The ship that you want to order to attack.
ship: The target.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order attack.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderDock

Syntax:
(shpOrderDock ship spaceObject)

Argument List:
ship: The ship that you want to order to dock.
spaceObject: The target to dock with.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order dock.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderEscort

Syntax:
(shpOrderEscort ship spaceObject [number])

Argument List:
ship: The ship that you want to order to escort.
spaceObject: The target to escort.
number:

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order escort the spaceObject.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderFollow

Syntax:
(shpOrderFollow ship spaceObject)

Argument List:
ship: The ship that you want to order to follow.
spaceObject: The target to follow.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order follow the spaceObject.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderGate

Syntax:
(shpOrderGate ship [spaceObject])

Argument List:
ship: The ship that you want to order to gate.
spaceObject: The star gate you want to gate at.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order gate out.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderGoto

Syntax:
(shpOrderGoto ship vector)

Argument List:
ship: The ship that you want to fly to a position.
vector: Where the ship will fly to.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship an order to fly to the position.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderGuard

Syntax:
(shpOrderGuard ship spaceObject)

Argument List:
ship: The ship that you want to order to guard.
spaceObject: The target to guard.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order guard the spaceObject.

Example:

Comment:
Allows you to give orders to ships.

[Betelgeuse]

Name:
shpOrderHold

Syntax:
(shpOrderHold ship [number])

Argument List:
ship: The ship that you want to order to hold position.
number: How long to hold position.

Returns:
condition: True if successful, Nil otherwise.

Category:
ship, order

Description:
Gives the ship the order hold position.

Example:

Comment:
Allows you to give orders to ships.