GetPartyList - Revision history

Sunjammer: Applying template, cleaning up example

2011-09-07T11:54:16Z

Applying template, cleaning up example

Sunjammer: Marked for my attention

2011-08-31T22:01:11Z

Marked for my attention

Yokmp: corrected the object[] to object[]

2011-02-28T17:08:00Z

corrected the [[object[]]] to object[]

GameScripting: Added mutch information and an example

2011-01-12T17:10:03Z

Added mutch information and an example

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-31T22:37:17Z

Generated by Sunjammer's Dragon Age Script Paser

BryanDerksen: 1 revision: re-import with default parameter value parameters set

2009-07-31T22:28:52Z

1 revision: re-import with default parameter value parameters set

BryanDerksen: 1 revision: Importing auto-generated function articles

2009-07-29T15:51:45Z

1 revision: Importing auto-generated function articles

Sunjammer: Generated by Sunjammer's Dragon Age Script Paser

2009-07-29T01:40:43Z

Generated by Sunjammer's Dragon Age Script Paser

New page

{{Generated with errors}}
{{dafunction
|name=GetPartyList
|brief=Returns the party list for the creature
|param1type=object
|param1name=oCreature
|param1desc=
|returntype=object[]
|returndesc=
|sourcefile=script.ldf
|sourcemodule=
}}













[[Category: Party and group control]]

@@ Line 1: / Line 1: @@
-{{ToDoListItem|Sunjammer}}
+{{dafunction
-Returns the party list for the creature
+|name          = GetPartyList
-<dascript>
+|brief         = Returns the party list for a creature.
-object[] GetPartyList(
+|param1type    = object
+|param1arra    =
-    object oCreature = -1
+|param1name    = oCreature
+|param1default = [[OBJECT_INVALID keyword|OBJECT_INVALID]]
-);
+|param1desc    = The object to test for returning the party
-</dascript>
+|returntype    = object
-'''Parameters:'''
+|returnarra    = true
+|returndesc    = Returns an array of all members in the creature's party
-''oCreature''
+|sourcemodule  =
+|sourcefile    = script.ldf
-'''Returns:'''
+}}
+<!-- == Description == -->
-An array containing the objects of all the party members.
-−
-'''Source:'''
-−
-[[script.ldf]]
 == Description ==
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 == Remarks ==
 <!-- This section contains additional comments, observations and known issues. -->
-The Hero is included in the Array
+If oCreature is not specified then the array returned is for the player's party and the player's character is included in the array.
-−
 == Examples ==
 <!-- This section contains examples transcluded from the snippet library. -->
+The following function checks the whole party for a specified item to have in inventory:
-  /********************************************/
+<dascript>
- /*
+  int Party_GetItemPossedBy(object oCreature, string sItemTag)
- * Description:
- * Checks the whole party for a specified
- * item to have in inventory (conversation
- * condition script)
-−
- * Created By: GameScripting
- * Created On: 12.01.2011
- */
- /********************************************/
-−
-  int StartingConditional()
+  {
      object oItem;
+     int nPartyMember;
-     // We'll loop though the whole party to check for one of the followers
-     // to have the specified item
+     // get the party list and its size
-     for(i; i < nPartySize; i++)
+    object[] oPartyMembers = GetPartyList(oCreature);
+     {
-         // Get the Item-Object
+         // check if the item exists and if so return true
-         oItem = GetItemPossessedBy(oPartyList[i], "MyItemTag");
+         oItem = GetItemPossessedBy(oPartyMembers[nPartyMember], sItemTag);
-−
-        // If the object is valid return true ...
          if(IsObjectValid(oItem))
+         {
@@ Line 68: / Line 42: @@
+     }
-     // ... otherwise return false
+     // otherwise return false
      return FALSE;
+  }
+</dascript>
 == See also ==
 <!-- This section contains links to articles, functions or constant groups. -->
-[[GetParty]]()
+[[GetParty]]
 [[Category: Party and group control]]

← Older revision		Revision as of 22:01, 31 August 2011
Line 1:		Line 1:
		+	{{ToDoListItem\|Sunjammer}}
	Returns the party list for the creature		Returns the party list for the creature
	<dascript>		<dascript>

@@ Line 1: / Line 1: @@
-{{dafunction
+Returns the party list for the creature
-|name=GetPartyList
+<dascript>
-|brief=Returns the party list for the creature
+object[] GetPartyList(
-|param1type=object
-|param1name=oCreature
-|param1desc=
-|param1default=-1
-|returntype=object[]
-|returndesc=An array containing the objects of all the party members.
-|sourcefile=script.ldf
-|sourcemodule=
-}}
 == Description ==
 <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
@@ Line 68: / Line 74: @@
 == See also ==
 <!-- This section contains links to articles, functions or constant groups. -->
-GetParty()
+[[GetParty]]()
 [[Category: Party and group control]]

← Older revision	Revision as of 22:28, 31 July 2009
(No difference)

← Older revision	Revision as of 15:51, 29 July 2009
(No difference)