Background for Skyrim SE
Member of the Actor script
voidfunctionSetPlayerTeammate(boolabTeammate=true, boolabCanDoFavor=true)Native

Description

Wiki Description

Flags this actor as a teammate of the player or not. Once an NPC becomes a teammate, the following becomes true:

  1. NPC will sneak if the player sneaks, stop sneaking if the player stops sneaking.
  2. NPC will draw a weapon if the player draws a weapon.
  3. NPC will equip their best armor (instead of wearing their default Outfit)
  4. Crimes committed by the NPC are considered crimes the player has committed.
  5. (Optional) NPC can be issued commands.

Documentation Comment

Sets or clears this actor as a teammate of the player
abCanDoFavor - OPTIONAL default is true the teammate can do favors


Parameters

  1. boolabTeammate=true

    CK Wiki Description

    Whether to set or clear the actor's teammate status.

    • Default:True
  2. boolabCanDoFavor=true

    CK Wiki Description

    Whether to set or clear the actor's ability to do favors when they are the player's teammate.

    • Default:True

Examples

; Set Buddy as a teammate
Buddy.SetPlayerTeammate()
; Clear buddy's teammate status
Buddy.SetPlayerTeammate(false)

Auto-Generated Example

bool myBool__abTeammate
bool myBool__abCanDoFavor

myActor__toCallFunctionOn.SetPlayerTeammate(myBool__abTeammate, myBool__abCanDoFavor)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.