Difference between revisions of "ListRemoveForm"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Omzy
(new fose function)
 
imported>Odessa
(added that it returns index too + see also)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function
{{Function
  |origin = FOSE1
  |origin = FOSE1
  |summary = Removes a form from a [[FormList]]. The function returns the index of the removed form.
  |summary = Removes the specified form from the form list. Returns the index of the removed form.  
  |name = ListRemoveForm
  |name = ListRemoveForm
|returnVal = oldIndex
  |returnType = int
  |returnType = int
  |arguments =  
  |arguments =  
   {{FunctionArgument
   {{FunctionArgument
   |Name = FormListID
   |Name = form list
   |Type = ref
   |Type = ref
   }}{{FunctionArgument
   }}{{FunctionArgument
   |Name = FormID
   |Name = form
   |Type = ref
   |Type = ref
   }}
   }}
|example = ListRemoveForm myFormList myForm
}}
}}
==Notes==
*See [[ListRemoveNthForm]] for removing the form that resides at a particular index.
==See Also==
==See Also==
*[[ListAddForm]]
*[[ListAddReference]]
*[[ListRemoveNthForm]]
*[[ListRemoveNthForm]]
*[[ListReplaceForm]]
*[[ListClear]]
*[[ListReplaceNthForm]]
*[[Ar_Erase]]
*[[ListGetForm]]
[[Category:Functions_(FOSE)]]
*[[ListGetNthForm]]
*[[ListGetFormIndex]]
*[[ListGetcount]]
*[[AddFormToFormList]]
*[[IsInList]]
*[[IsWeaponInList]]
 
[[Category:List Functions]]
[[Category:List Functions]]

Latest revision as of 13:41, 29 June 2014

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

A function added by the Fallout Script Extender.

Description

Removes the specified form from the form list. Returns the index of the removed form.

Syntax

[help]
(int) ListRemoveForm form list:ref form:ref

See Also