GetNumSummons

Revision as of 10:18, 24 December 2009 by 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 ...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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