Difference between revisions of "AddPerk"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>DewiMorgan
(→‎Notes: copying warning note from category perk)
imported>JT
 
(11 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Function
{{Function
|origin = GECK1
|origin = GECK1
|summary = Increments the rank of the specified perk on an Actor.  If the specified Actor doesn't already have the perk, then it will be added with rank 1.
|summary = Increments the rank of the specified perk on an Actor.  If the specified Actor doesn't already have the perk, then it will be added with rank 1.
|referenceType = Actor
|name = AddPerk
|arguments = {{FunctionArgument
|returnType = void
    |Name = PerkID
|referenceType = [ActorRefID]
    |Type = ref
|arguments =  
  {{FunctionArgument
  |Name = PerkID
  |Type = ref
   }}
   }}
|example = BuddyRef.AddPerk LittleSlugger
|example = BuddyRef.AddPerk LittleSlugger
 
Buddy now has the benefits of the little slugger perk.
Buddy now has the benefits of the little slugger perk.
}}
}}


==Notes==
==Notes==
*Note that games saved with mods installed (and given to the Player) that add new Perks may crash the game when those save games are loaded without the necessary mod(s) installed. If you know the FormId of the Perk, you can remove it from yourself using the console. Modders are strongly recommended to implement some in-game means for players to remove perks from their character should they wish to uninstall, as finding the FormIDs may be too complex a task for some.
* With Fallout 3 version 1.4 or older: Loading a savegame in which the player has a mod-created perk, when the mod that created it is no longer installed, may crash the game. That issue was fixed in Fallout v1.5. If you know the FormId of the Perk, you can remove it from yourself using the console. Modders are also advised to provide an in-game means for players to remove perks, should they wish to uninstall while keeping older versions of FO3, or at least provide instructions on how to remove the perks.
*This function is new in the GECK, and was not available in the TES4 Construction Set.
 
* One simple way is to provide an "uninstaller" esm file, that the user must install, load their game, and save it, before they remove the mod. The esm will do nothing but remove the perks, and contains one quest, called something like "MyPerkRemovalQuest", set to "start game enabled", with a Quest-type script:
    ScriptName MyPerkRemovalQuestScript
   
    Begin GameMode
        player.RemovePerk MyExamplePerk
        StopQuest MyPerkRemovalQuest
    End


==See Also==
==See Also==
[[RemovePerk]]
*[[RemovePerk]]
*[[HasPerk]]


[[Category:Functions]]
[[Category:Functions]]
[[Category:Functions (GECK 1.1)]]
[[Category:Player Functions]]
[[Category:Player Functions]]
[[Category:Player Functions (GECK 1.1)]]
[[Category:Perk]]
[[Category:Perk]]

Latest revision as of 18:21, 17 July 2015

< [[::Category:Functions|Category:Functions]]

A function included in the GECK version 1.1.0.36.

Description

Increments the rank of the specified perk on an Actor. If the specified Actor doesn't already have the perk, then it will be added with rank 1.

Syntax

[help]
[ActorRefID].AddPerk PerkID:ref

Example

BuddyRef.AddPerk LittleSlugger

Buddy now has the benefits of the little slugger perk.

Notes

  • With Fallout 3 version 1.4 or older: Loading a savegame in which the player has a mod-created perk, when the mod that created it is no longer installed, may crash the game. That issue was fixed in Fallout v1.5. If you know the FormId of the Perk, you can remove it from yourself using the console. Modders are also advised to provide an in-game means for players to remove perks, should they wish to uninstall while keeping older versions of FO3, or at least provide instructions on how to remove the perks.
  • One simple way is to provide an "uninstaller" esm file, that the user must install, load their game, and save it, before they remove the mod. The esm will do nothing but remove the perks, and contains one quest, called something like "MyPerkRemovalQuest", set to "start game enabled", with a Quest-type script:
   ScriptName MyPerkRemovalQuestScript
   
   Begin GameMode
       player.RemovePerk MyExamplePerk
       StopQuest MyPerkRemovalQuest
   End

See Also