Difference between revisions of "RemoveRef - RefCollectionAlias"
Jump to navigation
Jump to search
imported>Plplecuyer |
imported>Ice Eyes m (→Parameters: Corrected parameter name) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
'''Member of:''' [[RefCollectionAlias Script]] | '''Member of:''' [[RefCollectionAlias Script]] | ||
Removes the given | Removes the given reference from this collection | ||
== Syntax == | == Syntax == | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Function RemoveRef(ObjectReference | Function RemoveRef(ObjectReference akRemoveRef) native | ||
</source> | </source> | ||
== Parameters == | == Parameters == | ||
* | *akRemoveRef: The [[ObjectReference Script|ObjectReference]] to remove from this alias | ||
== Return Value == | == Return Value == | ||
| Line 24: | Line 21: | ||
== Notes == | == Notes == | ||
* 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 - RefCollectionAlias|GetCount]] function. | |||
== See Also == | == See Also == | ||
*[[RefCollectionAlias Script]] | *[[RefCollectionAlias Script]] | ||
*[[ | *[[Clear - LocationAlias|LocationAlias-Clear]] | ||
*[[ | *[[Clear - ReferenceAlias|ReferenceAlias-Clear]] | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Non-Delayed Native Functions]] | |||
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) nativeParameters[edit | edit source]
- akRemoveRef: The ObjectReference to remove from this alias
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.