Difference between revisions of "User:CraftySentinel"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
imported>CraftySentinel
m (Updated to allow word wrapping for examples)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
Hey, this here be my User page... It's not much to look at but hey who actually looks at peoples user pages?
==Game Script: Global Functions (Example)==


I enjoy a good bit o modding started with Mount and Blade Warbands then moved onto Oblivion, X3, and now here I am contributing to this here Creation kit wiki.
{|class="wikitable" width =100%
|-
|align="right" style="width:5%; border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[AddAchievement - Game|'''AddAchievement''']](Int ''aiAchievementID'')


Since I don't want you to leave empty handed here's a navbar of all Papyrus Script Objects enjoy:
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Adds the specified achievement/trophy to the player's gamer profile.
|-


=== Formatting Ideas ===
|align="right" style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[AddPerkPoints - Game|'''AddPerkPoints''']](Int ''aiPerkPoints'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Adds the given number of perk points to the player. Clamped at 255.
|-


==== Original ====
|align="right" style="border-width: 1px 0 0 0"|
'''Function [[AddForm - FormList|AddForm]](Form apForm)'''
|style="border-width: 1px 0 0 0"|
*Adds the given form to the form list.
|style="border-width: 1px 0 0 0"|[[AdvanceSkill - Game|'''AdvanceSkill''']](String ''asSkillName'', Float ''afMagnitude'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Advance the given skill on the player by the provided amount of skill usage
|-


'''Int Function [[Find - FormList|Find]](Form apForm)'''
|align="right" valign="top" style="border-width: 1px 0 0 0"|Bool
*Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0; padding-left: 18em; text-indent: -18em;"|[[AddHavokBallAndSocketConstraint - Game|'''AddHavokBallAndSocketConstraint''']](ObjectReference ''arRefA'', String ''arRefANode'', ObjectReference ''arRefB'', String ''arRefBNode'', Float ''afRefALocalOffsetX'', Float ''afRefALocalOffsetY'', Float ''afRefALocalOffsetZ'', Float ''afRefBLocalOffsetX'', Float ''afRefBLocalOffsetY'', Float ''afRefBLocalOffsetZ'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-


'''Form Function [[GetAt - FormList|GetAt]](int aiIndex)'''
|align="right" style="border-width: 1px 0 0 0"|Int
*Returns the form in the list at index ''aiIndex''.
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[CalculateFavorCost - Game|'''CalculateFavorCost''']](Int ''aiFavorPrice'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Calculates how many points the player would have to pay for a favor of the specified price.
|-


'''int Function [[GetSize - FormList|GetSize]]()'''
|align="right" style="border-width: 1px 0 0 0"|
*Returns the number of forms in the form list.
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[ClearPrison - Game|'''ClearPrison'''()]]
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|}


'''bool Function [[HasForm - FormList|HasForm]](Form akForm)'''
==Game Script: Global Functions (Alternate Example)==
*Returns whether the passed-in form is in this form list.


'''Function [[RemoveAddedForm - FormList|RemoveAddedForm]](Form apForm)'''
{|class="wikitable" width =100%
*Removes the given added form from the form list.
|-
|align="right" style="width:5%; border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[AddAchievement - Game|'''AddAchievement''']](Int ''aiAchievementID'')


'''Function [[Revert - FormList|Revert]]()'''
|-
*Removes all script added forms from the form list.
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Adds the specified achievement/trophy to the player's gamer profile.
|-


|align="right" style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[AddPerkPoints - Game|'''AddPerkPoints''']](Int ''aiPerkPoints'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Adds the given number of perk points to the player. Clamped at 255.
|-


==== Definitions with Indented Descriptions====
|align="right" style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[AdvanceSkill - Game|'''AdvanceSkill''']](String ''asSkillName'', Float ''afMagnitude'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Advance the given skill on the player by the provided amount of skill usage
|-


|align="right" valign="top" style="border-width: 1px 0 0 0"|Bool
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0; padding-left: 2em; text-indent: -2em;"|[[AddHavokBallAndSocketConstraint - Game|'''AddHavokBallAndSocketConstraint''']](ObjectReference ''arRefA'', String ''arRefANode'', ObjectReference ''arRefB'', String ''arRefBNode'', Float ''afRefALocalOffsetX'', Float ''afRefALocalOffsetY'', Float ''afRefALocalOffsetZ'', Float ''afRefBLocalOffsetX'', Float ''afRefBLocalOffsetY'', Float ''afRefBLocalOffsetZ'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-


*'''[[AddForm - FormList|Function '''AddForm'''(Form ''apForm'')]]'''
|align="right" style="border-width: 1px 0 0 0"|Int
::Adds the given form to the form list.
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[CalculateFavorCost - Game|'''CalculateFavorCost''']](Int ''aiFavorPrice'')
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Calculates how many points the player would have to pay for a favor of the specified price.
|-


|align="right" style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|
|style="border-width: 1px 0 0 0"|[[ClearPrison - Game|'''ClearPrison'''()]]
|-
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|
|style="border-width: 0 0 1px 0"|Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|}


*'''[[Find - FormList|Int Function '''Find'''(Form ''apForm'')]]'''
<hr />
::Finds the specified form in the form list and returns its index or returns -1 if it's not a member.




*'''[[GetAt - FormList|Form Function '''GetAt'''(Int ''aiIndex'')]]'''
Hey, this here be my User page... It's not much to look at but hey who actually looks at peoples user pages?
::Returns the form in the list at index ''aiIndex''.


I enjoy a good bit o modding started with Mount and Blade Warbands then moved onto Oblivion, X3, and now here I am contributing to this here Creation kit wiki.


*'''[[GetSize - FormList|Int Function '''GetSize'''()]]'''
Since I don't want you to leave empty handed here's a navbar of all Papyrus Script Objects enjoy:
::Returns the number of forms in the form list.
 
 
*'''[[HasForm - FormList|Bool Function '''HasForm'''(Form ''akForm'')]]'''
::Returns whether the passed-in form is in this form list.
 
 
*'''[[RemoveAddedForm - FormList|Function '''RemoveAddedForm'''(Form ''apForm'')]]'''
::Removes the given added form from the form list.
 
 
*'''[[Revert - FormList|Function '''Revert'''()]]'''
::Removes all script added forms from the form list.


=== Script Function Nav Box ===
=== Script Function Nav Box ===

Latest revision as of 01:22, 3 November 2013

Game Script: Global Functions (Example)[edit | edit source]

AddAchievement(Int aiAchievementID)
Adds the specified achievement/trophy to the player's gamer profile.
AddPerkPoints(Int aiPerkPoints)
Adds the given number of perk points to the player. Clamped at 255.
AdvanceSkill(String asSkillName, Float afMagnitude)
Advance the given skill on the player by the provided amount of skill usage
Bool AddHavokBallAndSocketConstraint(ObjectReference arRefA, String arRefANode, ObjectReference arRefB, String arRefBNode, Float afRefALocalOffsetX, Float afRefALocalOffsetY, Float afRefALocalOffsetZ, Float afRefBLocalOffsetX, Float afRefBLocalOffsetY, Float afRefBLocalOffsetZ)
Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
Int CalculateFavorCost(Int aiFavorPrice)
Calculates how many points the player would have to pay for a favor of the specified price.
ClearPrison()
Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.

Game Script: Global Functions (Alternate Example)[edit | edit source]

AddAchievement(Int aiAchievementID)
Adds the specified achievement/trophy to the player's gamer profile.
AddPerkPoints(Int aiPerkPoints)
Adds the given number of perk points to the player. Clamped at 255.
AdvanceSkill(String asSkillName, Float afMagnitude)
Advance the given skill on the player by the provided amount of skill usage
Bool AddHavokBallAndSocketConstraint(ObjectReference arRefA, String arRefANode, ObjectReference arRefB, String arRefBNode, Float afRefALocalOffsetX, Float afRefALocalOffsetY, Float afRefALocalOffsetZ, Float afRefBLocalOffsetX, Float afRefBLocalOffsetY, Float afRefBLocalOffsetZ)
Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
Int CalculateFavorCost(Int aiFavorPrice)
Calculates how many points the player would have to pay for a favor of the specified price.
ClearPrison()
Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.


Hey, this here be my User page... It's not much to look at but hey who actually looks at peoples user pages?

I enjoy a good bit o modding started with Mount and Blade Warbands then moved onto Oblivion, X3, and now here I am contributing to this here Creation kit wiki.

Since I don't want you to leave empty handed here's a navbar of all Papyrus Script Objects enjoy:

Script Function Nav Box[edit | edit source]

Papyrus Script Objects
Action - Activator - ActiveMagicEffect - Actor - ActorBase - Alias - Ammo - Apparatus - Armor - ArmorAddon - AssociationType - Book - Cell - Class - ColorForm - CombatStyle - ConstructibleObject - Container - Debug - Door - EffectShader - Enchantment - EncounterZone - EquipSlot - Explosion - Faction - Flora - Form - FormList - Furniture - Game - GlobalVariable - Hazard - HeadPart - Idle - ImageSpaceModifier - ImpactDataSet - Ingredient - Input - Key - Keyword - LeveledActor - LeveledItem - LeveledSpell - Light - Location - LocationAlias - LocationRefType - MagicEffect - Math - Message - MiscObject - MusicType - ObjectReference - Outfit - Package - Perk - Potion - Projectile - Quest - Race - ReferenceAlias - Scene - Scroll - Shout - SKSE - SoulGem - Sound - SoundCategory - Spell - Static - StringUtil - TalkingActivator - TextureSet - Topic - TopicInfo - UI - Utility - VisualEffect - VoiceType - Weapon - Weather - WordOfPower - WorldSpace