Editing
TryToAddToFaction - ReferenceAlias
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
[[Category:Scripting]] [[Category:Papyrus]] '''Member of:''' [[ReferenceAlias Script]] This is a convenient way to add an actor in an alias to a faction without calling [[GetActorReference - ReferenceAlias|GetActorReference]]() on it. It's mostly useful in cases where you have lots of aliases that may or may not be filled and you want to call [[AddToFaction - Actor|AddToFaction]]() on them without having to test for a reference being present first. == Syntax == <syntaxhighlight lang="papyrus"> bool Function TryToAddToFaction(Faction FactionToAddTo) Actor ActorRef = GetActorReference() if ActorRef ActorRef.AddToFaction(FactionToAddTo) Return True EndIf Return False EndFunction </syntaxhighlight> == Parameters == *FactionToAddTo: The faction to add the actor to == Return Value == True if the actor was added to the faction, false if no actor existed to be added. == Notes: == * True is a reflection that the actor reference existed -> and AddToFaction() was called on it * AddtoFaction() is an external call to the actor script, which does not wait, or return a value. * Consquently, add to faction can still be queued or processing by the time this function returns true. * False behaves as expected, no reference in alias, no actions performed == Examples == <syntaxhighlight lang="papyrus"> ; Try to add the boss to the bandit faction BossAlias.TryToAddToFaction(BanditFaction) </syntaxhighlight> == See Also == *[[ReferenceAlias Script]] *[[TryToRemoveFromFaction - ReferenceAlias]] *[[AddToFaction - Actor]]
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
Edit source
View history
More
Search
Navigation
Landing page
Tutorials
Game Systems
Editor Reference
Scripting Reference
Recent changes
Help
Tools
What links here
Related changes
Special pages
Page information
Page values