Oolite JavaScript Reference: Condition scripts - Revision history

Cim: 1.81 update

2015-04-18T10:18:22Z

1.81 update

Cim: /* Condition scripts */ updateEquipmentPrice

2014-12-15T22:41:31Z

‎Condition scripts: updateEquipmentPrice

Cim: /* allowAwardEquipment */ 1.79 changes, and note of standard condition script

2014-01-19T11:56:10Z

‎allowAwardEquipment: 1.79 changes, and note of standard condition script

Cim: 1.77

2013-01-08T17:38:34Z

1.77

Cim: /* allowAwardEquipment */ context parameter

2012-11-18T16:40:45Z

‎allowAwardEquipment: context parameter

Cim: /* Condition scripts */ Clarify interaction with legacy conditions

2012-07-25T21:02:49Z

‎Condition scripts: Clarify interaction with legacy conditions

Cim: Initial documentation of condition scripts

2012-07-25T21:01:32Z

Initial documentation of condition scripts

New page

'''NOTE: This page documents a feature planned for Oolite 1.77, which is potentially subject to significant change before then.'''

=Condition scripts=
Condition scripts are used to set conditions on the appearance of ships and equipment beyond the basics possible in [[shipdata.plist]], [[shipyard.plist]] and [[equipment.plist]]. They supersede the "conditions" parameters in those plists, which use the legacy scripting engine.

Conditions scripts may define any or all of the following functions. There is a single instance of each condition script regardless of how many ships and equipment items use it, so variables may be shared between calls in <code>this._property</code>

==allowAwardEquipment==
{{oolite-method-added|1.77}}

This method is called when the game engine needs to know whether a particular ship can have equipment fitted. This may be because the player is looking at possible upgrades at a station, or from a call to [[Oolite_JavaScript_Reference:_Ship#canAwardEquipment|ship.canAwardEquipment]] or [[Oolite_JavaScript_Reference:_Ship#canAwardEquipment|ship.awardEquipment]], or for other similar reasons. The equipment key and a reference to the ship entity are passed as parameters. If the method does not exist, or returns a value other than <code>false</code>, then the equipment may be added or offered for sale (subject to other conditions, of course)

this.allowAwardEquipment = function(eqKey, ship)
{
// your code here
return bool;
}

==allowOfferShip==
{{oolite-method-added|1.77}}

This method is called when the game engine is considering adding a ship managed by this condition script to a shipyard. If the method does not exist, or returns a value other than <code>false</code>, then the ship may appear for sale (or it may not, for a variety of other reasons). The ship key from shipyard.plist is passed as a parameter.

this.allowOfferShip = function(shipKey)
{
// your code here
return bool;
}

==allowSpawnShip==
{{oolite-method-added|1.77}}

This method is called when the game engine is considering spawning a ship managed by this condition script. If the method does not exist, or returns a value other than <code>false</code>, then the ship may be spawned (or it may not, if another ship with the appropriate role is selected instead). The ship key from shipdata.plist is passed as a parameter.

this.allowSpawnShip = function(shipKey)
{
// your code here
return bool;
}

[[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 17:38, 8 January 2013
Line 1:		Line 1:
−	'''NOTE: This page documents a feature planned for Oolite 1.77, which is potentially subject to significant change before then.'''
−
	=Condition scripts=		=Condition scripts=
	Condition scripts are used to set conditions on the appearance of ships and equipment beyond the basics possible in [[shipdata.plist]], [[shipyard.plist]] and [[equipment.plist]]. They have a similar purpose to the "conditions" parameters in those plists, which use the legacy scripting engine, but have the full flexibility of the Javascript scripting engine. If both "conditions" and a condition script are specified for the same item, they will both be tested (but you should never need to do this).		Condition scripts are used to set conditions on the appearance of ships and equipment beyond the basics possible in [[shipdata.plist]], [[shipyard.plist]] and [[equipment.plist]]. They have a similar purpose to the "conditions" parameters in those plists, which use the legacy scripting engine, but have the full flexibility of the Javascript scripting engine. If both "conditions" and a condition script are specified for the same item, they will both be tested (but you should never need to do this).

@@ Line 1: / Line 1: @@
 =Condition scripts=
-Condition scripts are used to set conditions on the appearance of ships and equipment beyond the basics possible in [[shipdata.plist]], [[shipyard.plist]] and [[equipment.plist]]. They have a similar purpose to the "conditions" parameters in those plists, which use the legacy scripting engine, but have the full flexibility of the Javascript scripting engine. If both "conditions" and a condition script are specified for the same item, they will both be tested (but you should never need to do this).
+Condition scripts are used to set conditions on the appearance of ships and equipment beyond the basics possible in [[shipdata.plist]], [[shipyard.plist]], [[shiplibrary.plist]] and [[equipment.plist]]. They have a similar purpose to the "conditions" parameters in those plists, which use the legacy scripting engine, but have the full flexibility of the Javascript scripting engine. If both "conditions" and a condition script are specified for the same item, they will both be tested (but you should never need to do this).
 Conditions scripts may define any or all of the following functions. There is a single instance of each condition script regardless of how many ships and equipment items use it, so variables may be shared between calls in <code>this._property</code>
@@ Line 38: / Line 38: @@
  this.allowOfferShip = function(shipKey)
+ {
    // your code here

@@ Line 3: / Line 3: @@
 Conditions scripts may define any or all of the following functions. There is a single instance of each condition script regardless of how many ships and equipment items use it, so variables may be shared between calls in <code>this._property</code>
 ==allowAwardEquipment==
@@ Line 52: / Line 54: @@
+ }

@@ Line 21: / Line 21: @@
    return bool;
+ }
 ==allowOfferShip==

@@ Line 11: / Line 11: @@
 This method is called when the game engine needs to know whether a particular ship can have equipment fitted. This may be because the player is looking at possible upgrades at a station, or from a call to [[Oolite_JavaScript_Reference:_Ship#canAwardEquipment|ship.canAwardEquipment]] or [[Oolite_JavaScript_Reference:_Ship#canAwardEquipment|ship.awardEquipment]], or for other similar reasons. The equipment key and a reference to the ship entity are passed as parameters. If the method does not exist, or returns a value other than <code>false</code>, then the equipment may be added or offered for sale (subject to other conditions, of course)
+ {
    // your code here