Difference between revisions of "RemoveScript"

From GECK

(Automated import of articles)
 
(Does not work with MGEF)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''RemoveScript'''
 
 
{{Function
 
{{Function
 
  |origin = FOSE1
 
  |origin = FOSE1
  |summary = Removes the script of the reference or passed object.
+
  |summary = Removes the script of the calling reference or passed object, and returns it.
 
  |name = RemoveScript
 
  |name = RemoveScript
  |returnType = ref
+
  |returnType = Script:form
 
  |referenceType = ref
 
  |referenceType = ref
 
  |arguments =  
 
  |arguments =  
 
   {{FunctionArgument
 
   {{FunctionArgument
   |Name = item
+
   |Name = ScriptableObject
   |Type = ref
+
   |Type = form
 
   |Optional = optional
 
   |Optional = optional
 
   }}
 
   }}
 
}}
 
}}
 +
==Example==
 +
<pre>
 +
ref OldScript
 +
 +
set OldScript to SunnyREF.RemoveScript
 +
 +
; or (required for non-references):
 +
 +
set OldScript to RemoveScript SunnyREF
 +
</pre>
 +
==Notes==
 +
* As of NVSE 4.6.2, this function does not work when called on a Base Effect (MGEF).
 +
==See Also==
 +
*[[IsScripted]]
 +
*[[GetScript]]
 +
*[[SetScript]]
 +
 
[[Category:Functions_(FOSE)]]
 
[[Category:Functions_(FOSE)]]
 +
[[Category:Script Functions]]

Latest revision as of 07:56, 27 February 2015

A function added by the Fallout Script Extender.

Description

Removes the script of the calling reference or passed object, and returns it.

Syntax

(Script:form) ref.RemoveScript ScriptableObject:form

Example

ref OldScript

set OldScript to SunnyREF.RemoveScript

; or (required for non-references):

set OldScript to RemoveScript SunnyREF

Notes

  • As of NVSE 4.6.2, this function does not work when called on a Base Effect (MGEF).

See Also

Personal tools