Difference between revisions of "User:CraftySentinel"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
(Just testing other formats I have in mind.)
imported>CraftySentinel
m (Updated to allow word wrapping for examples)
 
(17 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.
 
Since I don't want you to leave empty handed here's a navbar of all Papyrus Script Objects enjoy:
{|class="wikitable" style="width: 80%; margin: 1em auto 1em auto;"
!Papyrus Script Objects
|- style="font-size: 85%; text-align: center;"
|[[Action Script|Action]] - [[Activator Script|Activator]] - [[ActiveMagicEffect Script|ActiveMagicEffect]] - [[Actor Script|Actor]] - [[ActorBase Script|ActorBase]] - [[Alias Script|Alias]] - [[Ammo Script|Ammo]] - [[Apparatus Script|Apparatus]] - [[Armor Script|Armor]] - [[ArmorAddon Script|ArmorAddon]] - [[AssociationType Script|AssociationType]] - [[Book Script|Book]] - [[Cell Script|Cell]] - [[Class Script|Class]] - [[ColorForm Script|ColorForm]] - [[CombatStyle Script|CombatStyle]] - [[ConstructibleObject Script|ConstructibleObject]] - [[Container Script|Container]] - [[Debug Script|Debug]] - [[Door Script|Door]] - [[EffectShader Script|EffectShader]] - [[Enchantment Script|Enchantment]] - [[EncounterZone Script|EncounterZone]] - [[EquipSlot Script|EquipSlot]] - [[Explosion Script|Explosion]] - [[Faction Script|Faction]] - [[Flora Script|Flora]] - [[Form Script|Form]] - [[FormList Script|FormList]] - [[Furniture Script|Furniture]] - [[Game Script|Game]] - [[GlobalVariable Script|GlobalVariable]] - [[Hazard Script|Hazard]] - [[HeadPart Script|HeadPart]] - [[Idle Script|Idle]] - [[ImageSpaceModifier Script|ImageSpaceModifier]] - [[ImpactDataSet Script|ImpactDataSet]] - [[Ingredient Script|Ingredient]] - [[Input Script|Input]] - [[Key Script|Key]] - [[Keyword Script|Keyword]] - [[LeveledActor Script|LeveledActor]] - [[LeveledItem Script|LeveledItem]] - [[LeveledSpell Script|LeveledSpell]] - [[Light Script|Light]] - [[Location Script|Location]] - [[LocationAlias Script|LocationAlias]] - [[LocationRefType Script|LocationRefType]] - [[MagicEffect Script|MagicEffect]] - [[Math Script|Math]] - [[Message Script|Message]] - [[MiscObject Script|MiscObject]] - [[MusicType Script|MusicType]] - [[ObjectReference Script|ObjectReference]] - [[Outfit Script|Outfit]] - [[Package Script|Package]] - [[Perk Script|Perk]] - [[Potion Script|Potion]] - [[Projectile Script|Projectile]] - [[Quest Script|Quest]] - [[Race Script|Race]] - [[ReferenceAlias Script|ReferenceAlias]] - [[Scene Script|Scene]] - [[Scroll Script|Scroll]] - [[Shout Script|Shout]] - [[SKSE Script| SKSE]] - [[SoulGem Script|SoulGem]] - [[Sound Script|Sound]] - [[SoundCategory Script|SoundCategory]] - [[Spell Script|Spell]] - [[Static Script|Static]] - [[StringUtil Script|StringUtil]] - [[TalkingActivator Script|TalkingActivator]] - [[TextureSet Script|TextureSet]] - [[Topic Script|Topic]] - [[TopicInfo Script|TopicInfo]] - [[UI Script|UI]] - [[Utility Script|Utility]] - [[VisualEffect Script|VisualEffect]] - [[VoiceType Script|VoiceType]] - [[Weapon Script|Weapon]] - [[Weather Script|Weather]] - [[WordOfPower Script|WordOfPower]] - [[WorldSpace Script|WorldSpace]]
|}
 
=== Formatting Ideas ===
 
==== Original ====
'''Function [[AddForm - FormList|AddForm]](Form apForm)'''
*Adds the given form to the form list.
 
'''Int Function [[Find - FormList|Find]](Form apForm)'''
*Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
 
'''Form Function [[GetAt - FormList|GetAt]](int aiIndex)'''
*Returns the form in the list at index ''aiIndex''.
 
'''int Function [[GetSize - FormList|GetSize]]()'''
*Returns the number of forms in the form list.
 
'''bool Function [[HasForm - FormList|HasForm]](Form akForm)'''
*Returns whether the passed-in form is in this form list.
 
'''Function [[RemoveAddedForm - FormList|RemoveAddedForm]](Form apForm)'''
*Removes the given added form from the form list.
 
'''Function [[Revert - FormList|Revert]]()'''
*Removes all script added forms from the form list.
 
 
==== Current ====


{|class="wikitable" width =100%
{|class="wikitable" width =100%
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]]
|Adds the given form to the form list.
|-
|[[Find - FormList|Int '''Find'''(Form ''apForm'')]]
|Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
|-
|[[GetAt - FormList|Form '''GetAt'''(Int ''aiIndex'')]]
|Returns the form in the list at index ''aiIndex''.
|-
|-
|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'')


|[[GetSize - FormList|Int '''GetSize'''()]]
|Returns the number of forms in the form list.
|-
|-
 
|style="border-width: 0 0 1px 0"|
|[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]]
|style="border-width: 0 0 1px 0"|
|Returns whether the passed-in form is in this form list.
|style="border-width: 0 0 1px 0"|Adds the specified achievement/trophy to the player's gamer profile.
|-
|-


|[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]]
|align="right" style="border-width: 1px 0 0 0"|
|Removes the given added form from the form list.
|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"|
|[[Revert - FormList|'''Revert'''()]]
|style="border-width: 0 0 1px 0"|
|Removes all script added forms from the form list.
|style="border-width: 0 0 1px 0"|Adds the given number of perk points to the player. Clamped at 255.
|-
|-


|}
|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'')
 
==== ToC colour no Border ====
 
{|class="toccolours" width =100%
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]]
|Adds the given form to the form list.
|-
|-
 
|style="border-width: 0 0 1px 0"|
|[[Find - FormList|Int '''Find'''(Form ''apForm'')]]
|style="border-width: 0 0 1px 0"|
|Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
|style="border-width: 0 0 1px 0"|Advance the given skill on the player by the provided amount of skill usage
|-
|-


|[[GetAt - FormList|Form '''GetAt'''(Int ''aiIndex'')]]
|align="right" valign="top" style="border-width: 1px 0 0 0"|Bool
|Returns the form in the list at index ''aiIndex''.
|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"|
|[[GetSize - FormList|Int '''GetSize'''()]]
|style="border-width: 0 0 1px 0"|
|Returns the number of forms in the form list.
|style="border-width: 0 0 1px 0"|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-
|-


|[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]]
|align="right" style="border-width: 1px 0 0 0"|Int
|Returns whether the passed-in form is in this 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"|
|[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]]
|style="border-width: 0 0 1px 0"|
|Removes the given added form from the form list.
|style="border-width: 0 0 1px 0"|Calculates how many points the player would have to pay for a favor of the specified price.
|-
|-


|[[Revert - FormList|'''Revert'''()]]
|align="right" style="border-width: 1px 0 0 0"|
|Removes all script added forms from 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.
|}
|}


==Game Script: Global Functions (Alternate Example)==


==== No Border ====
{|class="wikitable" width =100%
 
{|width =100%
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]]
|Adds the given form to 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'')


|[[Find - FormList|Int '''Find'''(Form ''apForm'')]]
|Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
|-
|-
 
|style="border-width: 0 0 1px 0"|
|[[GetAt - FormList|Form '''GetAt'''(Int ''aiIndex'')]]
|style="border-width: 0 0 1px 0"|
|Returns the form in the list at index ''aiIndex''.
|style="border-width: 0 0 1px 0"|Adds the specified achievement/trophy to the player's gamer profile.
|-
|-


|[[GetSize - FormList|Int '''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"|[[AddPerkPoints - Game|'''AddPerkPoints''']](Int ''aiPerkPoints'')
|-
|-
 
|style="border-width: 0 0 1px 0"|
|[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]]
|style="border-width: 0 0 1px 0"|
|Returns whether the passed-in form is in this form list.
|style="border-width: 0 0 1px 0"|Adds the given number of perk points to the player. Clamped at 255.
|-
|-


|[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]]
|align="right" style="border-width: 1px 0 0 0"|
|Removes the given added form from the form list.
|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"|
|[[Revert - FormList|'''Revert'''()]]
|style="border-width: 0 0 1px 0"|
|Removes all script added forms from the form list.
|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'')
==== Indented Descriptions Using Table ====
 
{|width=100% cellpadding=5
 
|[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]]
::Adds the given form to the form list.
|-
|-
 
|style="border-width: 0 0 1px 0"|
|[[Find - FormList|Int '''Find'''(Form ''apForm'')]]
|style="border-width: 0 0 1px 0"|
::Finds the specified form in the form list and returns its index or returns -1 if it's not a member.
|style="border-width: 0 0 1px 0"|Adds a ball-and-socket constraint between two rigid bodies, identified by their ref and node names
|-
|-


|[[GetAt - FormList|Form '''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"|
|[[GetSize - FormList|Int '''GetSize'''()]]
|style="border-width: 0 0 1px 0"|
::Returns the number of forms in the form list.
|style="border-width: 0 0 1px 0"|Calculates how many points the player would have to pay for a favor of the specified price.
|-
|-


|[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]]
|align="right" style="border-width: 1px 0 0 0"|
::Returns whether the passed-in form is in this 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"|
|[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]]
|style="border-width: 0 0 1px 0"|
::Removes the given added form from the form list.
|style="border-width: 0 0 1px 0"|Clears all Prison variables on the PlayerCharacter so the game will know he is out of prison.
|-
 
|[[Revert - FormList|'''Revert'''()]]
::Removes all script added forms from the form list.
|-
 
|}
|}


<hr />


==== Indented Descriptions without table formatting ====


[[AddForm - FormList|'''AddForm'''(Form ''apForm'')]]
Hey, this here be my User page... It's not much to look at but hey who actually looks at peoples user pages?
::Adds the given form to the form list.


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


[[GetAt - FormList|Form '''GetAt'''(Int ''aiIndex'')]]
Since I don't want you to leave empty handed here's a navbar of all Papyrus Script Objects enjoy:
::Returns the form in the list at index ''aiIndex''.


[[GetSize - FormList|Int '''GetSize'''()]]
=== Script Function Nav Box ===
::Returns the number of forms in the form list.
{|class="wikitable" style="width: 80%; margin: 1em auto 1em auto;"
 
!Papyrus Script Objects
[[HasForm - FormList|Bool '''HasForm'''(Form ''akForm'')]]
|- style="font-size: 85%; text-align: center;"
::Returns whether the passed-in form is in this form list.
|[[Action Script|Action]] - [[Activator Script|Activator]] - [[ActiveMagicEffect Script|ActiveMagicEffect]] - [[Actor Script|Actor]] - [[ActorBase Script|ActorBase]] - [[Alias Script|Alias]] - [[Ammo Script|Ammo]] - [[Apparatus Script|Apparatus]] - [[Armor Script|Armor]] - [[ArmorAddon Script|ArmorAddon]] - [[AssociationType Script|AssociationType]] - [[Book Script|Book]] - [[Cell Script|Cell]] - [[Class Script|Class]] - [[ColorForm Script|ColorForm]] - [[CombatStyle Script|CombatStyle]] - [[ConstructibleObject Script|ConstructibleObject]] - [[Container Script|Container]] - [[Debug Script|Debug]] - [[Door Script|Door]] - [[EffectShader Script|EffectShader]] - [[Enchantment Script|Enchantment]] - [[EncounterZone Script|EncounterZone]] - [[EquipSlot Script|EquipSlot]] - [[Explosion Script|Explosion]] - [[Faction Script|Faction]] - [[Flora Script|Flora]] - [[Form Script|Form]] - [[FormList Script|FormList]] - [[Furniture Script|Furniture]] - [[Game Script|Game]] - [[GlobalVariable Script|GlobalVariable]] - [[Hazard Script|Hazard]] - [[HeadPart Script|HeadPart]] - [[Idle Script|Idle]] - [[ImageSpaceModifier Script|ImageSpaceModifier]] - [[ImpactDataSet Script|ImpactDataSet]] - [[Ingredient Script|Ingredient]] - [[Input Script|Input]] - [[Key Script|Key]] - [[Keyword Script|Keyword]] - [[LeveledActor Script|LeveledActor]] - [[LeveledItem Script|LeveledItem]] - [[LeveledSpell Script|LeveledSpell]] - [[Light Script|Light]] - [[Location Script|Location]] - [[LocationAlias Script|LocationAlias]] - [[LocationRefType Script|LocationRefType]] - [[MagicEffect Script|MagicEffect]] - [[Math Script|Math]] - [[Message Script|Message]] - [[MiscObject Script|MiscObject]] - [[MusicType Script|MusicType]] - [[ObjectReference Script|ObjectReference]] - [[Outfit Script|Outfit]] - [[Package Script|Package]] - [[Perk Script|Perk]] - [[Potion Script|Potion]] - [[Projectile Script|Projectile]] - [[Quest Script|Quest]] - [[Race Script|Race]] - [[ReferenceAlias Script|ReferenceAlias]] - [[Scene Script|Scene]] - [[Scroll Script|Scroll]] - [[Shout Script|Shout]] - [[SKSE Script| SKSE]] - [[SoulGem Script|SoulGem]] - [[Sound Script|Sound]] - [[SoundCategory Script|SoundCategory]] - [[Spell Script|Spell]] - [[Static Script|Static]] - [[StringUtil Script|StringUtil]] - [[TalkingActivator Script|TalkingActivator]] - [[TextureSet Script|TextureSet]] - [[Topic Script|Topic]] - [[TopicInfo Script|TopicInfo]] - [[UI Script|UI]] - [[Utility Script|Utility]] - [[VisualEffect Script|VisualEffect]] - [[VoiceType Script|VoiceType]] - [[Weapon Script|Weapon]] - [[Weather Script|Weather]] - [[WordOfPower Script|WordOfPower]] - [[WorldSpace Script|WorldSpace]]
 
|}
[[RemoveAddedForm - FormList|'''RemoveAddedForm'''(Form ''apForm'')]]
::Removes the given added form from the form list.
 
[[Revert - FormList|'''Revert'''()]]
::Removes all script added forms from the form list.

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
Retrieved from "https://ck.uesp.net/w/index.php?title=User:CraftySentinel&oldid=808"