The RefCollectionAlias Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

No properties found.

• Found in:
  • Vanilla

  eventOnActivate(ObjectReferenceakSenderRef, ObjectReferenceakActionRef)

  Event received when this reference is activated

• Found in:
  • Vanilla

  eventOnCellAttach(ObjectReferenceakSenderRef)

  Event received when this object's parent cell is attached

• Found in:
  • Vanilla

  eventOnCellDetach(ObjectReferenceakSenderRef)

  Event received when this object's parent cell is detached

• Found in:
  • Vanilla

  eventOnCellLoad(ObjectReferenceakSenderRef)

  Event received when every object in this object's parent cell is loaded (TODO: Find restrictions)

• Found in:
  • Vanilla

  eventOnClose(ObjectReferenceakSenderRef, ObjectReferenceakActionRef)

  Event received when this object is closed

• Found in:
  • Vanilla

  eventOnContainerChanged(ObjectReferenceakSenderRef, ObjectReferenceakNewContainer, ObjectReferenceakOldContainer)

  Event received when this object enters, exits, or changes containers

• Found in:
  • Vanilla

  eventOnDestructionStageChanged(ObjectReferenceakSenderRef, intaiOldStage, intaiCurrentStage)

  Event received when this reference's destruction stage has changed

• Found in:
  • Vanilla

  eventOnEquipped(ObjectReferenceakSenderRef, ActorakActor)

  Event received when this object is equipped by an actor

• Found in:
  • Vanilla

  eventOnExitFurniture(ObjectReferenceakSenderRef, ObjectReferenceakActionRef)

  Event received when this furniture is exited.

• Found in:
  • Vanilla

  eventOnGrab(ObjectReferenceakSenderRef)

  Event received when this object is grabbed by the player

• Found in:
  • Vanilla

  eventOnItemAdded(ObjectReferenceakSenderRef, FormakBaseItem, intaiItemCount, ObjectReferenceakItemReference, ObjectReferenceakSourceContainer)

  Event received when an item is added to this object's inventory. If the item is a persistant reference, akItemReference will
  point at it - otherwise the parameter will be None

• Found in:
  • Vanilla

  eventOnItemRemoved(ObjectReferenceakSenderRef, FormakBaseItem, intaiItemCount, ObjectReferenceakItemReference, ObjectReferenceakDestContainer)

  Event received when an item is removed from this object's inventory. If the item is a persistant reference, akItemReference
  will point at it - otherwise the parameter will be None

• Found in:
  • Vanilla

  eventOnLoad(ObjectReferenceakSenderRef)

  Event recieved when this object is completely loaded - will be fired every time this object is loaded

• Found in:
  • Vanilla

  eventOnLockStateChanged(ObjectReferenceakSenderRef)

  Event received when the lock on this object changes

• Found in:
  • Vanilla

  eventOnOpen(ObjectReferenceakSenderRef, ObjectReferenceakActionRef)

  Event received when this object is opened

• Found in:
  • Vanilla

  eventOnPipboyRadioDetection(ObjectReferenceakSenderRef, boolabDetected)

  Event that occurs when the Pipboy enters/leaves the outer-radius of this radio ref

• Found in:
  • Vanilla

  eventOnPowerOn(ObjectReferenceakSenderRef, ObjectReferenceakPowerGenerator)

  Event received when a workshop item receives power

• Found in:
  • Vanilla

  eventOnPowerOff(ObjectReferenceakSenderRef)

  Event received when a workshop loses all power

• Found in:
  • Vanilla

  eventOnRead(ObjectReferenceakSenderRef)

  Event received when this object, if a book, is read

• Found in:
  • Vanilla

  eventOnRelease(ObjectReferenceakSenderRef)

  Event received when this object is released by the player

• Found in:
  • Vanilla

  eventOnReset(ObjectReferenceakSenderRef)

  Event received when this reference is reset

• Found in:
  • Vanilla

  eventOnSell(ObjectReferenceakSenderRef, ActorakSeller)

  Event received when this reference is sold by an actor

• Found in:
  • Vanilla

  eventOnSpellCast(ObjectReferenceakSenderRef, FormakSpell)

  Event received when a spell is cast by this object

• Found in:
  • Vanilla

  eventOnTranslationAlmostComplete(ObjectReferenceakSenderRef)

  Event received when translation is almost complete (from a call to TranslateTo, "almost" is determined by a gamesetting, default is 90% of the way)

• Found in:
  • Vanilla

  eventOnTranslationComplete(ObjectReferenceakSenderRef)

  Event received when translation is complete (from a call to TranslateTo)

• Found in:
  • Vanilla

  eventOnTranslationFailed(ObjectReferenceakSenderRef)

  Event received when translation is aborted (from a call to StopTranslateTo)

• Found in:
  • Vanilla

  eventOnTrapHitStart(ObjectReferenceakSenderRef, ObjectReferenceakTarget, floatafXVel, floatafYVel, floatafZVel, floatafXPos, floatafYPos, floatafZPos, intaeMaterial, boolabInitialHit, intaeMotionType)

  Event recieved when this starts hitting a target

• Found in:
  • Vanilla

  eventOnTrapHitStop(ObjectReferenceakSenderRef, ObjectReferenceakTarget)

  Event recieved when this stops hitting a target

• Found in:
  • Vanilla

  eventOnTriggerEnter(ObjectReferenceakSenderRef, ObjectReferenceakActionRef)

  Event received when this trigger volume is entered

• Found in:
  • Vanilla

  eventOnTriggerLeave(ObjectReferenceakSenderRef, ObjectReferenceakActionRef)

  Event received when this trigger volume is left

• Found in:
  • Vanilla

  eventOnUnequipped(ObjectReferenceakSenderRef, ActorakActor)

  Event received when this object is unequipped by an actor

• Found in:
  • Vanilla

  eventOnUnload(ObjectReferenceakSenderRef)

  Event recieved when this object is being unloaded - will be fired every time this object is unloaded

• Found in:
  • Vanilla

  eventOnWorkshopMode(ObjectReferenceakSenderRef, boolaStart)

  Event received when the player enters or leaves Workshop Mode

• Found in:
  • Vanilla

  eventOnWorkshopObjectDestroyed(ObjectReferenceakSenderRef, ObjectReferenceakReference)

  Event received when a workshop item is destroyed ( removed from world and added back to workshop )

• Found in:
  • Vanilla

  eventOnWorkshopObjectGrabbed(ObjectReferenceakSenderRef, ObjectReferenceakReference)

  Event received when the player grabs an existing object reference for edit while in Workshop mode.

• Found in:
  • Vanilla

  eventOnWorkshopObjectMoved(ObjectReferenceakSenderRef, ObjectReferenceakReference)

  Event received when an existing workshop item is moved in the world

• Found in:
  • Vanilla

  eventOnWorkshopObjectPlaced(ObjectReferenceakSenderRef, ObjectReferenceakReference)

  Event received when a workshop item is placed in the world

• Found in:
  • Vanilla

  eventOnWorkshopNPCTransfer(ObjectReferenceakSenderRef, LocationakNewWorkshop, KeywordakActionKW)

  Event that occurs when a workshop NPC is directed to move to another settlement

• Found in:
  • Vanilla

  eventOnWorkshopObjectRepaired(ObjectReferenceakSenderRef, ObjectReferenceakReference)

  Event received when a workshop item has been repaired

• Found in:
  • Vanilla

  eventOnCombatStateChanged(ObjectReferenceakSenderRef, ActorakTarget, intaeCombatState)

  Event that is triggered when this actor's combat state against the target changes
  State is as follows:
  0 - not in combat
  1 - in combat
  2 - searching

• Found in:
  • Vanilla

  eventOnCommandModeCompleteCommand(ObjectReferenceakSenderRef, intaeCommand, ObjectReferenceakTarget)

  Event received when the object completes a command in command mode.
  Type is as follows:
  0 - None
  1 - Call
  2 - Follow
  3 - Move
  4 - Attack
  5 - Inspect
  6 - Retrieve
  7 - Stay
  8 - Release
  9 - Heal

• Found in:
  • Vanilla

  eventOnCommandModeEnter(ObjectReferenceakSenderRef)

  Event received when the player begins commanding this object

• Found in:
  • Vanilla

  eventOnCommandModeExit(ObjectReferenceakSenderRef)

  Event received when the player ends commanding this object

• Found in:
  • Vanilla

  eventOnCommandModeGiveCommand(ObjectReferenceakSenderRef, intaeCommand, ObjectReferenceakTarget)

  Event received when the player gives object a command in command mode.
  Type is as follows:
  0 - None
  1 - Call
  2 - Follow
  3 - Move
  4 - Attack
  5 - Inspect
  6 - Retrieve
  7 - Stay
  8 - Release
  9 - Heal

• Found in:
  • Vanilla

  eventOnCompanionDismiss(ObjectReferenceakSenderRef)

  Received when player dismisses teammate companion

• Found in:
  • Vanilla

  eventOnConsciousnessStateChanged(ObjectReferenceakSenderRef, boolabUnconscious)

  Event that is triggered when this actor's consciousness state changes

• Found in:
  • Vanilla

  eventOnCripple(ObjectReferenceakSenderRef, ActorValueakActorValue, boolabCrippled)

  Recieved immeadiately after a limb has become crippled or uncrippled.

• Found in:
  • Vanilla

  eventOnDeferredKill(ObjectReferenceakSenderRef, ActorakKiller)

  Event that is triggered when this actor gets a deferred kill added
  (they were in deferred kill mode and got "killed")

• Found in:
  • Vanilla

  eventOnDeath(ObjectReferenceakSenderRef, ActorakKiller)

  Event that is triggered when this actor finishes dying (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnDifficultyChanged(ObjectReferenceakSenderRef, intaOldDifficulty, intaNewDifficulty)

  Event received when the player changes their difficulty
  Type is as follows:
  0 - Very Easy
  1 - Easy
  2 - Normal
  3 - Hard
  4 - Very Hard
  5 - Survival (no Hardcore) DEFUNCT
  6 - Survival w/ Hardcore

• Found in:
  • Vanilla

  eventOnDying(ObjectReferenceakSenderRef, ActorakKiller)

  Event that is triggered when this actor begins dying (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnEnterBleedout(ObjectReferenceakSenderRef)

  Event received when an actor enters bleedout. (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnEnterSneaking(ObjectReferenceakSenderRef)

  Event received when an actor enters sneaking.

• Found in:
  • Vanilla

  eventOnEscortWaitStart(ObjectReferenceakSenderRef)

  Event received when this actor is in an Escort procedure and begins waiting for the escorted actor to catch up.

• Found in:
  • Vanilla

  eventOnEscortWaitStop(ObjectReferenceakSenderRef)

  Event received when this actor is in an Escort procedure and stops waiting because the escorted actor has caught up.

• Found in:
  • Vanilla

  eventOnGetUp(ObjectReferenceakSenderRef, ObjectReferenceakFurniture)

  Event that is triggered when this actor leaves the furniture

• Found in:
  • Vanilla

  eventOnHolotapeChatter(ObjectReferenceakSenderRef, stringastrChatter, floatafNumericData)

  Event that occurs when a flash program on a holotape wants to communicate with script.

• Found in:
  • Vanilla

  eventOnHolotapePlay(ObjectReferenceakSenderRef, ObjectReferenceaTerminalRef)

  Event that occurs when a holotape is played via Pipboy or terminal.

• Found in:
  • Vanilla

  eventOnItemEquipped(ObjectReferenceakSenderRef, FormakBaseObject, ObjectReferenceakReference)

  Event received when this actor equips something - akReference may be None if object is not persistent (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnItemUnequipped(ObjectReferenceakSenderRef, FormakBaseObject, ObjectReferenceakReference)

  Event received when this actor unequips something - akReference may be None if object is not persistent (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnKill(ObjectReferenceakSenderRef, ActorakVictim)

  Event that is triggered when this actor kills another

• Found in:
  • Vanilla

  eventOnLocationChange(ObjectReferenceakSenderRef, LocationakOldLoc, LocationakNewLoc)

  Event that is triggered when this actor changes from one location to another (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnPackageChange(ObjectReferenceakSenderRef, PackageakOldPackage)

  Event received when this actor's package changes (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnPackageEnd(ObjectReferenceakSenderRef, PackageakOldPackage)

  Event received when this actor's package ends (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnPackageStart(ObjectReferenceakSenderRef, PackageakNewPackage)

  Event received when this actor starts a new package (only if this alias points at an actor)

• Found in:
  • Vanilla

  eventOnPartialCripple(ObjectReferenceakSenderRef, ActorValueakActorValue, boolabCrippled)

  Recieved immeadiately after the limb of a robot (or other actor whose race allows sub-segment damage) has become (or ceased to be) partially crippled.

• Found in:
  • Vanilla

  eventOnPickpocketFailed(ObjectReferenceakSenderRef)

  Received when the player fails to pickpocket this actor

• Found in:
  • Vanilla

  eventOnPlayerCreateRobot(ObjectReferenceakSenderRef, ActorakNewRobot)

  Received when player creates a new robot

• Found in:
  • Vanilla

  eventOnPlayerDialogueTarget(ObjectReferenceakSenderRef)

  Event received when ref goes into dialogue with player

• Found in:
  • Vanilla

  eventOnPlayerEnterVertibird(ObjectReferenceakSenderRef, ObjectReferenceakVertibird)

  Received when player enters vertibird

• Found in:
  • Vanilla

  eventOnPlayerFallLongDistance(ObjectReferenceakSenderRef, floatafDamage)

  Received when player takes fall damage

• Found in:
  • Vanilla

  eventOnPlayerFireWeapon(ObjectReferenceakSenderRef, FormakBaseObject)

  Received when player fires a weapon out of combat and based on timer

• Found in:
  • Vanilla

  eventOnPlayerHealTeammate(ObjectReferenceakSenderRef, ActorakTeammate)

  Received when player heals his teammate

• Found in:
  • Vanilla

  eventOnPlayerLoadGame(ObjectReferenceakSenderRef)

  Received immediately after the player has loaded a save game. A good time to check for additional content.

• Found in:
  • Vanilla

  eventOnPlayerModArmorWeapon(ObjectReferenceakSenderRef, FormakBaseObject, ObjectModakModBaseObject)

  Received when player mods a weapon or armor in the menu.

• Found in:
  • Vanilla

  eventOnPlayerModRobot(ObjectReferenceakSenderRef, ActorakRobot, ObjectModakModBaseObject)

  Received when the player mods a robot

• Found in:
  • Vanilla

  eventOnPlayerSwimming(ObjectReferenceakSenderRef)

  Received when player starts swimming

• Found in:
  • Vanilla

  eventOnPlayerUseWorkBench(ObjectReferenceakSenderRef, ObjectReferenceakWorkBench)

  Received when player uses a workbench

• Found in:
  • Vanilla

  eventOnRaceSwitchComplete(ObjectReferenceakSenderRef)

  Event received when this actor finishes changing its race

• Found in:
  • Vanilla

  eventOnSit(ObjectReferenceakSenderRef, ObjectReferenceakFurniture)

  Event that is triggered when this actor sits in the furniture

• Found in:
  • Vanilla

  eventOnSpeechChallengeAvailable(ObjectReferenceakSenderRef, ObjectReferenceakSpeaker)

  Received when player gets a speech challenge in dialogue

• Found in:
  • Vanilla

  voidfunctionAddToFaction(FactionakFaction)

  Calls Actor.AddToFaction(...) on all the actors in the collection

• Found in:
  • Vanilla

  voidfunctionBlockActivation(boolabBlocked=true, boolabHideActivateText=false)

  Calls ObjectReference.BlockActivation(...) on all the references in the collection

• Found in:
  • Vanilla

  ActorfunctionGetActorAt(intaiIndex)

  kmk
  convenience function - casts the reference at aiIndex as an actor before returning it

• Found in:
  • Vanilla

  ObjectReferencefunctionGetFirstOwnedObject(ActoractorOwner)

  Returns first reference in collection that is owned by the specified actor

• Found in:
  • Vanilla

  voidfunctionEnableAll(boolbFadeIn=false)

  Calls ObjectReference.EnableNoWait(...) on all the references in the collection.

• Found in:
  • Vanilla

  voidfunctionDisableAll(boolbFadeOut=false)

  Calls ObjectReference.DisableNoWait(...) on all the references in the collection.

• Found in:
  • Vanilla

  voidfunctionEvaluateAll()

  Calls Actor.EvaluatePackage(...) on all the actors in the collection.

• Found in:
  • Vanilla

  voidfunctionMoveAllTo(ObjectReferenceakTarget)

  Calls ObjectReference.MoveTo(...) on all the references in the collection.

• Found in:
  • Vanilla

  boolfunctionIsOwnedObjectInList(ActoractorOwner)

  Returns true if actorOwner owns anything in the collection

• Found in:
  • Vanilla

  voidfunctionKillAll(ActorakKiller=NONE)

  Kills all the actors in this collection

• Found in:
  • Vanilla

  voidfunctionStartCombatAll(ActorakCombatTarget)

  Calls Actor.StartCombat(...) on all the actors in the collection.

• Found in:
  • Vanilla

  voidfunctionRemoveFromFaction(FactionakFaction)

  Calls Actor.RemoveFromFaction(...) on all the actors in the collection

• Found in:
  • Vanilla

  voidfunctionRemoveFromAllFactions()

  Calls Actor.RemoveFromAllFactions() on all the actors in the collection.

• Found in:
  • Vanilla

  voidfunctionResetAll()

  Calls ObjectReference.Reset(...) on all the references in the collection.

• Found in:
  • Vanilla

  voidfunctionSetProtected(boolbSetProtected=true)

  Calls Actor.SetProtected(...) on all the actors in the collection.

• Found in:
  • Vanilla

  voidfunctionSetEssential(boolbSetEssential=true)

  Calls Actor.SetEssential(...) on all the actors in the collection.

• Found in:
  • Vanilla

  voidfunctionAddRefCollection(RefCollectionAliasrefCollectionAliasToAdd)

  Adds the contents of the passed-in collection alias to this one.

• Found in:
  • Vanilla

  voidfunctionAddArray(ObjectReference[]refArrayToAdd)

  Adds the contents of the array to this collection.

• Found in:
  • Vanilla

  voidfunctionSetValue(ActorValueakActorValue, floatfValue)

  Calls ObjectReference.SetValue(...) on all the actors in the collection.

• Found in:
  • Vanilla

  boolfunctionLinkCollectionTo(RefCollectionAliasLinkedRefCollectionAlias, KeywordLinkKeyword=NONE, boolWrapLinks=false)

  LinkRefs each index of the RefCollectionAlias to the same index of the target RefCollectionAlias using the keyword specified. Can be set to wrap to the top of the target RefCollectionAlias if it runs out of indexes before the colleciton this is called on.

• Found in:
  • Vanilla

  voidfunctionAddRef(ObjectReferenceakNewRef)Native

  Adds the given ref to this collection

• Found in:
  • Vanilla

  intfunctionFind(ObjectReferenceakFindRef)Native

  Searches for the specified form in the form list, returning its index (or a negative number if the form isn't found in the list)

• Found in:
  • Vanilla

  ObjectReferencefunctionGetAt(intaiIndex)Native

  Gets the ref at the given index in this collection

• Found in:
  • Vanilla

  intfunctionGetCount()Native

  Gets the number of refs in this collection

• Found in:
  • Vanilla

  voidfunctionRemoveAll()Native

  Clears all references out of this collection. Will error if this alias is not optional.

• Found in:
  • Vanilla

  voidfunctionRemoveRef(ObjectReferenceakRemoveRef)Native

  Removes the given reference from this collection