Skip to content

Commit 07c420c

Browse files
authored
better documentation for setShiedsMax (#1729)
* New function for adding shields on Playership in scenarios I'm trying to write a scenario where one can upgrade the Playership. So this would be a nice feature. did this in the browser but I think it should not break anything :) * made your point clear in the documentation
1 parent 62a6508 commit 07c420c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/spaceObjects/shipTemplateBasedObject.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ REGISTER_SCRIPT_SUBCLASS_NO_CREATE(ShipTemplateBasedObject, SpaceObject)
5454
REGISTER_SCRIPT_CLASS_FUNCTION(ShipTemplateBasedObject, getShieldMax);
5555
/// Set the current amount of shields.
5656
REGISTER_SCRIPT_CLASS_FUNCTION(ShipTemplateBasedObject, setShields);
57-
/// Set the maximum shield level. Note that this does low the current shield level when the max becomes lower, but it does not increase the shield level.
57+
/// Set the maximum shield level, amount of parameters defines the amount of shields. (Up to a maximum of 8 shields). Note that this does low the current shield level when the max becomes lower, but it does not increase the shield level.
5858
/// A seperate call to setShield is needed for that.
5959
REGISTER_SCRIPT_CLASS_FUNCTION(ShipTemplateBasedObject, setShieldsMax);
6060
/// Set the icon to be used for this object on the radar.

0 commit comments

Comments
 (0)