Difference between revisions of "ReferenceAlias Script"

Jump to navigation Jump to search
109 bytes added ,  13:03, 20 February 2012
imported>Jlundin
 
imported>Jog
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
*Function [[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form akFilter)
'''Function [[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form akFilter)'''
**Adds an inventory event filter to this alias.
*Adds an inventory event filter to this alias.
*Function [[Clear - ReferenceAlias|Clear]]()
 
**Clears this alias from pointing at anything.
'''Function [[Clear - ReferenceAlias|Clear]]()'''
*bool Function [[ForceRefIfEmpty - ReferenceAlias|ForceRefIfEmpty]](ObjectReference akNewRef)
*Clears this alias from pointing at anything.
**Tries to force a reference into the alias, but only if it's already empty.
 
*Function [[ForceRefTo - ReferenceAlias|ForceRefTo]](ObjectReference akNewRef)
'''bool Function [[ForceRefIfEmpty - ReferenceAlias|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]]()
 
**Alias for GetActorReference().
'''Function [[ForceRefTo - ReferenceAlias|ForceRefTo]](ObjectReference akNewRef)'''
*Actor Function [[GetActorReference - ReferenceAlias|GetActorReference]]()
*Forces this alias to use the specified [[ObjectReference Script|ObjectReference]]
**Retrieves the alias's [[ObjectReference Script|ObjectReference]] cast as an [[Actor Script|Actor]].
 
*ObjectReference Function [[GetReference - ReferenceAlias|GetRef]]()
'''Actor Function [[GetActorReference - ReferenceAlias|GetActorRef]]()'''
**Alias for GetReference().
*Alias for GetActorReference().
*ObjectReference Function [[GetReference - ReferenceAlias|GetReference]]()
 
**Attempts to retrieve the [[ObjectReference Script|ObjectReference]] that this alias is pointing at
'''Actor Function [[GetActorReference - ReferenceAlias|GetActorReference]]()'''
*Function [[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()
*Retrieves the alias's [[ObjectReference Script|ObjectReference]] cast as an [[Actor Script|Actor]].
**Remove all inventory event filters on this alias.
 
*Function [[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form akFilter)
'''ObjectReference Function [[GetReference - ReferenceAlias|GetRef]]()'''
**Remove a specific inventory event filter.
*Alias for GetReference().
*bool Function [[TryToAddToFaction - ReferenceAlias|TryToAddToFaction]](Faction FactionToAddTo)
 
**Attempts to add the reference this alias points to to a faction
'''ObjectReference Function [[GetReference - ReferenceAlias|GetReference]]()'''
*bool Function [[TryToClear - ReferenceAlias|TryToClear]]()
*Attempts to retrieve the [[ObjectReference Script|ObjectReference]] that this alias is pointing at
**Attempts to clear this alias
 
*bool Function [[TryToDisable - ReferenceAlias|TryToDisable]]()
'''Function [[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()'''
**Attempts to disable the reference this alias points at
*Remove all inventory event filters on this alias.
*bool Function [[TryToDisableNoWait - ReferenceAlias|TryToDisableNoWait]]()
 
**Attempts to disable the reference this alias points at (the no-wait version)
'''Function [[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form akFilter)'''
*bool Function [[TryToEnable - ReferenceAlias|TryToEnable]]()
*Remove a specific inventory event filter.
**Attempts to enable the reference this alias points at
 
*bool Function [[TryToEnableNoWait - ReferenceAlias|TryToEnableNoWait]]()
'''bool Function [[TryToAddToFaction - ReferenceAlias|TryToAddToFaction]](Faction FactionToAddTo)'''
**Attempts to enable the reference this alias points at (no-wait version)
*Attempts to add the reference this alias points to to a faction
*bool Function [[TryToEvaluatePackage - ReferenceAlias|TryToEvaluatePackage]]()
 
**Attempts to get the actor this alias points at to re-evaluate his package stack
'''bool Function [[TryToClear - ReferenceAlias|TryToClear]]()'''
*bool Function [[TryToKill - ReferenceAlias|TryToKill]]()
*Attempts to clear this alias
**Attempts to kill the actor this alias points at
 
*bool Function [[TryToMoveTo - ReferenceAlias|TryToMoveTo]](ObjectReference RefToMoveTo)
'''bool Function [[TryToDisable - ReferenceAlias|TryToDisable]]()'''
**Attempts to move the reference this alias points to to the target reference
*Attempts to disable the reference this alias points at
*bool Function [[TryToRemoveFromFaction - ReferenceAlias|TryToRemoveFromFaction]](Faction FactionToRemoveFrom)
 
**Attempts to remove the reference this alias points to from a faction
'''bool Function [[TryToDisableNoWait - ReferenceAlias|TryToDisableNoWait]]()'''
*bool Function [[TryToReset - ReferenceAlias|TryToReset]]()
*Attempts to disable the reference this alias points at (the no-wait version)
**Attempts to reset the reference this alias points at
 
*bool Function [[TryToStopCombat - ReferenceAlias|TryToStopCombat]]()
'''bool Function [[TryToEnable - ReferenceAlias|TryToEnable]]()'''
**Attempts to remove the actor this alias points at from combat
*Attempts to enable the reference this alias points at
 
'''bool Function [[TryToEnableNoWait - ReferenceAlias|TryToEnableNoWait]]()'''
*Attempts to enable the reference this alias points at (no-wait version)
 
'''bool Function [[TryToEvaluatePackage - ReferenceAlias|TryToEvaluatePackage]]()'''
*Attempts to get the actor this alias points at to re-evaluate his package stack
 
'''bool Function [[TryToKill - ReferenceAlias|TryToKill]]()'''
*Attempts to kill the actor this alias points at
 
'''bool Function [[TryToMoveTo - ReferenceAlias|TryToMoveTo]](ObjectReference RefToMoveTo)'''
*Attempts to move the reference this alias points to to the target reference
 
'''bool Function [[TryToRemoveFromFaction - ReferenceAlias|TryToRemoveFromFaction]](Faction FactionToRemoveFrom)'''
*Attempts to remove the reference this alias points to from a faction
 
'''bool Function [[TryToReset - ReferenceAlias|TryToReset]]()'''
*Attempts to reset the reference this alias points at
 
'''bool Function [[TryToStopCombat - ReferenceAlias|TryToStopCombat]]()'''
*Attempts to remove the actor this alias points at from combat


== Events ==
== Events ==
Anonymous user

Navigation menu