Difference between revisions of "RemoveRef - RefCollectionAlias"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
(Added collection size notes)
imported>Ice Eyes
m (→‎Parameters: Corrected parameter name)
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
Function RemoveRef(ObjectReference akRefToRemove) native
Function RemoveRef(ObjectReference akRemoveRef) native
</source>
</source>


== Parameters ==
== Parameters ==
*akRefToRemove: The [[ObjectReference Script|ObjectReference]] to remove from this alias
*akRemoveRef: The [[ObjectReference Script|ObjectReference]] to remove from this alias


== Return Value ==
== Return Value ==

Latest revision as of 12:15, 19 June 2019

Member of: RefCollectionAlias Script

Removes the given reference from this collection

Syntax[edit | edit source]

Function RemoveRef(ObjectReference akRemoveRef) native

Parameters[edit | edit source]

Return Value[edit | edit source]

None.

Examples[edit | edit source]

;Take us out of the collection
Alias_TownsPeople.RemoveRef(self)

Notes[edit | edit source]

  • A RefCollectionAlias will automatically shrink and expand its size when items are added or removed. The collection's count can be measured with the GetCount function.

See Also[edit | edit source]