Difference between revisions of "GetNumSummons"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Kyoma
(New page: __NOTOC__ A User Function for use with Oblivion Script Extender '''Syntax:''' GetNumSummons Returns the number of summons that are active on ...)
 
imported>Kyoma
Line 17: Line 17:
Getting the number of summons active on a reference (in this case the player)
Getting the number of summons active on a reference (in this case the player)
  Let NumSummons := player.Call GetNumSummons
  Let NumSummons := player.Call GetNumSummons


==Code==
==Code==
Line 29: Line 28:
  let arFollowers := GetFollowers
  let arFollowers := GetFollowers
  let iFollower := GetNumFollowers
  let iFollower := GetNumFollowers
  While iFollower > 0
While iFollower > 0
  let iFollower -= 1
  let iFollower -= 1
  let rFollower := GetNthFollower iFollower
  let rFollower := GetNthFollower iFollower
Line 43: Line 41:
==See Also==  
==See Also==  
* [[User Functions]]
* [[User Functions]]
* [[GetNthSummon]]


[[Category: User Functions]]
[[Category: User Functions]]

Revision as of 10:24, 24 December 2009

A User Function for use with Oblivion Script Extender

Syntax:

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