Difference between revisions of "GetNumSummons"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Kyoma
imported>Kyoma
Line 3: Line 3:


'''Syntax:'''
'''Syntax:'''
  GetNumSummons
  (numSummons:short) reference.Call GetNumSummons
 
Returns the number of summons that are active on the reference.  
Returns the number of summons that are active on the reference.  


==Notes==
==Notes==
*This function must be called on a reference (Ref.call <function>)  
*This function must be called on a reference (Ref.call <function>)  
*Each summoned creature is counted seperately, even when they are of the same kind.
*Each summoned creature is counted seperately, even when they are of the same kind.


==Examples:==
==Examples:==
Line 37: Line 34:
  let arFollowers := ar_Null
  let arFollowers := ar_Null
  End  
  End  


==See Also==  
==See Also==  
Line 46: Line 42:


<!-- Begin Search Terms
<!-- Begin Search Terms
Summons
Summon
End Search Terms -->
End Search Terms -->

Revision as of 10:30, 24 December 2009

A User Function for use with Oblivion Script Extender

Syntax:

(numSummons:short) reference.Call GetNumSummons

Returns the number of summons that are active on the reference.

Notes

  • This function must be called on a reference (Ref.call <function>)
  • Each summoned creature is counted seperately, even when they are of the same kind.

Examples:

Getting the number of summons active on a reference (in this case the player)

Let NumSummons := player.Call GetNumSummons

Code

ScriptName GetNumSummons
array_var arFollowers
ref rFollower
long iFollower

Begin Function {}
	let arFollowers := GetFollowers
	let iFollower := GetNumFollowers
 	While iFollower > 0
		let iFollower -= 1
		let rFollower := GetNthFollower iFollower
		ar_Erase arFollowers ( ar_Find rFollower arFollowers )
	Loop

	SetFunctionValue ( ar_Size arFollowers )
	let arFollowers := ar_Null
End 

See Also