function list

[Betelgeuse]

Name:
shpGetClass

Syntax:
(shpGetClass ship)

Argument List:
ship: The ship that you want to get the UNID of.

Returns:
number: The UNID of the ship.

Category:
ship

Description:
Returns the UNID of the ship.

Example:

Comment:
Useful for seeing what kind of ship you are dealing with and acting accordingly.

[Betelgeuse]

Name:
shpGetDirection

Syntax:
(shpGetDirection ship)

Argument List:
ship: The ship that you want to get the direction of.

Returns:
number: The direction of the ship in degrees.

Category:
ship

Description:
Returns the direction of the ship.

Example:

Comment:
Useful for objJumpTo and objIncVel.

[Betelgeuse]

Name:
shpGetFuelLeft

Syntax:
(shpGetFuelLeft ship)

Argument List:
ship: The ship that you want the remaining fuel of.

Returns:
number: The amount of fuel left.

Category:
ship

Description:
Returns the amount of fuel in the ship.

Example:

Comment:
The same as shpConsumeFuel with no fuel consumed.

[Betelgeuse]

Name:
shpGetGlobalData

Syntax:
(objGetGlobalData number string)

Argument List:
number: The UNID of the ship you want the data from.
string: The name of the data you want.

Returns:
The data named by the string from the ships class. All ship in the same class share the same global data. Returns Nil if there is no data as named by the string.

Category:
ship, data

Description:
Returns the data named by the string for the ships class.

Example:

Comment:
Basically the same as objGetGlobalData except you are using an UNID instead of a space object.

[Betelgeuse]

Name:
shpGetItemCharges

Syntax:
(shpGetItemCharges ship itemStruct)

Argument List:
ship: The ship that the item is in.
itemStruct: The item that you want to see how many charges are on.

Returns:
number: The number of charges on the item.

Category:
ship, item

Description:
Returns the number of charges on the item.

Example:

Comment:
Don't ask me why this is a ship function. Your guess is as good as mine.

[Betelgeuse]

Name:
shpGetOrder

Syntax:
(shpGetOrder ship)

Argument List:
ship: The ship that you want the order from.

Returns:
string: A string representation of the ships current order.

Category:
ship, order

Description:
Returns what orders the ship is currently under.

Example:

Comment:
Useful for checking if a ship is busy or if it is ready for new orders.

[Betelgeuse]

Name:
shpGetShieldDamage

Syntax:
(shpGetShieldDamage ship)

Argument List:
ship: The ship that you want get the amount of damage the shields have.

Returns:
number: The amount of damage the ship's shield has.

Category:
ship, shield

Description:
Returns the amount of damage the ship's shield has.

Example:

Comment:
Used to see if the ship is fully charged.

[Betelgeuse]

Name:
shpGetShieldItemUNID

Syntax:
(shpGetShieldItemUNID ship)

Argument List:
ship: The ship that you want get the UNID the shields have.

Returns:
number: The UNID of the ship's shield.

Category:
ship, shield

Description:
Returns the UNID of the ship's shield.

Example:

Comment:
Can be used for interesting things like a disguising shield.

[Betelgeuse]

Name:
shpGetShieldMaxHitPoints

Syntax:
(shpGetShieldMaxHitPoints ship)

Argument List:
ship: The ship that you want get the max hit point the shields have.

Returns:
number: The max hit points of the ship's shield.

Category:
ship, shield

Description:
Returns the max hit points of the ship's shield.

Example:

Comment:
Not used in the xml files but still works fine.

[Betelgeuse]

Name:
shpInstallArmor

Syntax:
(shpInstallArmor ship itemListCursor number)

Argument List:
ship: The ship that you want install the armor.
itemListCursor: The pointer to the armor you want to install.
number: Where on the ship you want to install the armor.

Returns:
condition: True is successful.

Category:
ship, armor

Description:
Attempts to install the pointed to armor in the location.

Example:

Comment:
Not much use in code because it needs the itemListCursor and that can only be done with the player's interaction.

[Betelgeuse]

Name:
shpInstallAutopilot

Syntax:
(shpInstallAutopilot ship)

Argument List:
ship: The ship that you want install the auto pilot.

Returns:
condition: True is successful, Nil otherwise.

Category:
ship

Description:
Attempts to install the auto pilot.

Example:

Code: Select all

(shpInstallAutopilot gplayership)

Returns Nil. The player ships starts with auto pilot installed.

Comment:
No use in the current build do to the player ship has the auto pilot already installed at the start of the game.

[Betelgeuse]

Name:
shpInstallDevice

Syntax:
(shpInstallDevice ship expression)

Argument List:
ship: The ship that you want install the device on.
expression: Can take a item struct or an item list pointer. The device to install.

Returns:
condition: True is successful, Nil otherwise.

Category:
ship, install

Description:
Attempts to install the device indicated by the expression. The expression can be an item struct or an item list pointer.

Example:

Comment:
Very important function to allow you to change what is equipped from in code.

[Betelgeuse]

Name:
shpInstallTargetingComputer

Syntax:
(shpInstallTargetingComputer ship)

Argument List:
ship: The ship that you want install the targeting computer on.

Returns:
condition: True is successful, Nil otherwise.

Category:
ship, install

Description:
Attempts to install a targeting computer on the ship.

Example:

Code: Select all

(shpInstallTargetingComputer gplayership)

Attempts to install a targeting computer on the players ship.

Comment:
Limited use but the targeting computer is a very useful thing in game.

[Betelgeuse]

Name:
shpIsAutopilotInstalled

Syntax:
(shpIsAutopilotInstalled ship)

Argument List:
ship: The ship that you want check if it has an auto pilot.

Returns:
condition: True if the ship has an auto pilot, Nil otherwise.

Category:
ship, condition query

Description:
Returns true if the ship has an auto pilot.

Example:

Code: Select all

(shpIsAutopilotInstalled gplayership)

Returns True due to the fact the player's ship starts with an auto pilot.

Comment:
No use in the current build do to the player ship has the auto pilot already installed at the start of the game.

[Betelgeuse]

Name:
shpIsFuelCompatible

Syntax:
(shpIsFuelCompatible ship itemStruct)

Argument List:
ship: The ship that you want check if the fuel is compatible.
itemStruct: The item struct of the fuel you want to check.

Returns:
condition: True if the fuel is compatible with the ship, Nil otherwise.

Category:
ship, condition query, reactor

Description:
Returns true if the fuel is compatible with the ship and its reactor.

Example:

Comment:
Nice simple function allowing you to check if the fuel is compatible with the ship.