Transcendence Community Wiki

User Tools

Site Tools

Trace:
modding:function:objdepleteshields

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

modding:function:objdepleteshields [2014/12/27 04:40] – external edit 127.0.0.1modding:function:objdepleteshields [2017/02/03 21:47] (current) – Changed from "disable" to "deplete". This function doesn't disable shields. xephyr
Line 6: Line 6:
  
 ^ Syntax | (objDepleteShields obj) -> True/Nil | ^ Syntax | (objDepleteShields obj) -> True/Nil |
-^ Arguments | obj: The spaceObject that you want to disable the shields of. |+^ Arguments | obj: The spaceObject that you want to deplete the shields of. |
 ^ Returns | boolean: True if successful, otherwise Nil | ^ Returns | boolean: True if successful, otherwise Nil |
-^ Category | [[shield]], [[spaceobject]] | +^ Category | [[modding:function:space object functions]] | 
-^ Description | A function that disables the shields of the spaceObject. |+^ Description | A function that compeltely depletes the shields of the spaceObject. |
  
 === Example === === Example ===
  
 <code lisp>(objDepleteShields gPlayerShip)</code> <code lisp>(objDepleteShields gPlayerShip)</code>
-Disables the players shields.+ 
 +Completely depletes the player's shields. 
 Return to [[:Functions]] list Return to [[:Functions]] list
  
modding/function/objdepleteshields.1419655255.txt.gz · Last modified: 2017/02/03 21:47 (external edit)