Difference between revisions of "AddItemHealthPercent"

Revision as of 17:16, 2 March 2009

< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

AddItemHealthPercent adds an item to a container at a specified health percentage.

Actor.AddItemHealthPercent Item:ObjectID Count:int HealthPercent:float MessageHiddenFlag:int

player.AddItemHealthPercent WeapHuntingRifle 1 0.85

The player has 1 Hunting Rifle added to their inventory at 85% health.

When using this to create an item from a leveled list, note that the specified health percent overrides the health percentage set by the leveled list.

@@ Line 1: / Line 1: @@
-=='''Description'''==
+{{Function
+|origin = GECK1
+|summary = [[AddItemHealthPercent]] adds an item to a container at a specified health percentage.
+|referenceType = Actor|Container
+|arguments = {{FunctionArgument
+    |Name = Item
+    |Type = ObjectID
+  }}{{FunctionArgument
+    |Name = Count
+    |Type = int
+  }}{{FunctionArgument
+    |Name = HealthPercent
+    |Type = float
+  }}{{FunctionArgument
+    |Name = MessageHiddenFlag
+    |Type = int
+    |Optional = y
+  }}
+|example = player.AddItemHealthPercent WeapHuntingRifle 1 0.85
-'''AddItemHealthPercent''' Adds a damaged item to the specified container.
+The player has 1 Hunting Rifle added to their inventory at 85% health.
+}}
-=='''Syntax'''==
- [''ActorID|ContainerID''.]AddItemHealthPercent ''ItemID, Count, HealthPercent, MessageHiddenFlag''
-=='''Examples'''==
- buddyref.additemHealthPercent weapHuntingRifle 1 .85
-Buddy has 1 Hunting Rifle added to his inventory at a condition of 85%
 =='''Notes'''==
@@ Line 16: / Line 26: @@
 =='''See Also'''==
-[[AddItem]]<br>
+[[AddItem]]<br />
 [[RemoveItem]]
-<!--
-=='''Reference'''==
-None provided.
-<!-- [[AddItemHealthPercent_Reference|List of functions that use AddItemHealthPercent]]  (wiki) -->
 [[Category:Functions]]