Difference between revisions of "ReferenceAlias Script"

Jump to navigation Jump to search

ReferenceAlias Script (edit)

Revision as of 05:24, 24 October 2013

43 bytes added ,  05:24, 24 October 2013
m
→‎Member Functions: Formatting Change
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''Function [[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form akFilter)'''
*Adds an inventory event filter to this alias.


'''Function [[Clear - ReferenceAlias|Clear]]()'''
{|class="wikitable" width =100%
*Clears this alias from pointing at anything.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[AddInventoryEventFilter - ObjectReference|'''AddInventoryEventFilter'''(Form ''akFilter'')]]
|Adds an inventory event filter to this alias.
|-


'''bool Function [[ForceRefIfEmpty - ReferenceAlias|ForceRefIfEmpty]](ObjectReference akNewRef)'''
|[[Clear - ReferenceAlias|'''Clear'''()]]
*Tries to force a reference into the alias, but only if it's already empty.
|Clears this alias from pointing at anything.
|-


'''Function [[ForceRefTo - ReferenceAlias|ForceRefTo]](ObjectReference akNewRef)'''
|[[ForceRefIfEmpty - ReferenceAlias|Bool '''ForceRefIfEmpty'''(ObjectReference ''akNewRef'')]]
*Forces this alias to use the specified [[ObjectReference Script|ObjectReference]]
|Tries to force a reference into the alias, but only if it's already empty.
|-


'''Actor Function [[GetActorReference - ReferenceAlias|GetActorRef]]()'''
|[[ForceRefTo - ReferenceAlias|'''ForceRefTo'''(ObjectReference ''akNewRef'')]]
*Alias for GetActorReference().
|Forces this alias to use the specified [[ObjectReference Script|ObjectReference]]
|-


'''Actor Function [[GetActorReference - ReferenceAlias|GetActorReference]]()'''
|[[GetActorReference - ReferenceAlias|Actor '''GetActorReference'''()]]
*Retrieves the alias's [[ObjectReference Script|ObjectReference]] cast as an [[Actor Script|Actor]].
|Alias for GetActorReference().
|-


'''ObjectReference Function [[GetReference - ReferenceAlias|GetRef]]()'''
|[[GetActorReference - ReferenceAlias|Actor '''GetActorReference'''()]]
*Alias for GetReference().
|Retrieves the alias's [[ObjectReference Script|ObjectReference]] cast as an [[Actor Script|Actor]].
|-


'''ObjectReference Function [[GetReference - ReferenceAlias|GetReference]]()'''
|[[GetReference - ReferenceAlias|ObjectReference '''GetReference'''()]]
*Attempts to retrieve the [[ObjectReference Script|ObjectReference]] that this alias is pointing at
|Alias for GetReference().
|-


'''Function [[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()'''
|[[GetReference - ReferenceAlias|ObjectReference '''GetReference'''()]]
*Remove all inventory event filters on this alias.
|Attempts to retrieve the [[ObjectReference Script|ObjectReference]] that this alias is pointing at
|-


'''Function [[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form akFilter)'''
|[[RemoveAllInventoryEventFilters - ObjectReference|'''RemoveAllInventoryEventFilters'''()]]
*Remove a specific inventory event filter.
|Remove all inventory event filters on this alias.
|-


'''bool Function [[TryToAddToFaction - ReferenceAlias|TryToAddToFaction]](Faction FactionToAddTo)'''
|[[RemoveInventoryEventFilter - ObjectReference|'''RemoveInventoryEventFilter'''(Form ''akFilter'')]]
*Attempts to add the reference this alias points to to a faction
|Remove a specific inventory event filter.
|-


'''bool Function [[TryToClear - ReferenceAlias|TryToClear]]()'''
|[[TryToAddToFaction - ReferenceAlias|Bool '''TryToAddToFaction'''(Faction ''FactionToAddTo'')]]
*Attempts to clear this alias
|Attempts to add the reference this alias points to to a faction
|-


'''bool Function [[TryToDisable - ReferenceAlias|TryToDisable]]()'''
|[[TryToClear - ReferenceAlias|Bool '''TryToClear'''()]]
*Attempts to disable the reference this alias points at
|Attempts to clear this alias
|-


'''bool Function [[TryToDisableNoWait - ReferenceAlias|TryToDisableNoWait]]()'''
|[[TryToDisable - ReferenceAlias|Bool '''TryToDisable'''()]]
*Attempts to disable the reference this alias points at (the no-wait version)
|Attempts to disable the reference this alias points at
|-


'''bool Function [[TryToEnable - ReferenceAlias|TryToEnable]]()'''
|[[TryToDisableNoWait - ReferenceAlias|Bool '''TryToDisableNoWait'''()]]
*Attempts to enable the reference this alias points at
|Attempts to disable the reference this alias points at (the no-wait version)
|-


'''bool Function [[TryToEnableNoWait - ReferenceAlias|TryToEnableNoWait]]()'''
|[[TryToEnable - ReferenceAlias|Bool '''TryToEnable'''()]]
*Attempts to enable the reference this alias points at (no-wait version)
|Attempts to enable the reference this alias points at
|-


'''bool Function [[TryToEvaluatePackage - ReferenceAlias|TryToEvaluatePackage]]()'''
|[[TryToEnableNoWait - ReferenceAlias|Bool '''TryToEnableNoWait'''()]]
*Attempts to get the actor this alias points at to re-evaluate his package stack
|Attempts to enable the reference this alias points at (no-wait version)
|-


'''bool Function [[TryToKill - ReferenceAlias|TryToKill]]()'''
|[[TryToEvaluatePackage - ReferenceAlias|Bool '''TryToEvaluatePackage'''()]]
*Attempts to kill the actor this alias points at
|Attempts to get the actor this alias points at to re-evaluate his package stack
|-


'''bool Function [[TryToMoveTo - ReferenceAlias|TryToMoveTo]](ObjectReference RefToMoveTo)'''
|[[TryToKill - ReferenceAlias|Bool '''TryToKill'''()]]
*Attempts to move the reference this alias points to to the target reference
|Attempts to kill the actor this alias points at
|-


'''bool Function [[TryToRemoveFromFaction - ReferenceAlias|TryToRemoveFromFaction]](Faction FactionToRemoveFrom)'''
|[[TryToMoveTo - ReferenceAlias|Bool '''TryToMoveTo'''(ObjectReference ''RefToMoveTo'')]]
*Attempts to remove the reference this alias points to from a faction
|Attempts to move the reference this alias points to to the target reference
|-


'''bool Function [[TryToReset - ReferenceAlias|TryToReset]]()'''
|[[TryToRemoveFromFaction - ReferenceAlias|Bool '''TryToRemoveFromFaction'''(Faction ''FactionToRemoveFrom'')]]
*Attempts to reset the reference this alias points at
|Attempts to remove the reference this alias points to from a faction
|-


'''bool Function [[TryToStopCombat - ReferenceAlias|TryToStopCombat]]()'''
|[[TryToReset - ReferenceAlias|Bool '''TryToReset'''()]]
*Attempts to remove the actor this alias points at from combat
|Attempts to reset the reference this alias points at
|-
 
|[[TryToStopCombat - ReferenceAlias|Bool '''TryToStopCombat'''()]]
|Attempts to remove the actor this alias points at from combat
|-
 
|}


== Events ==
== Events ==
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/14740"

Navigation menu