Difference between revisions of "GetSoulSize - SoulGem"

From the CreationKit Wiki
Jump to navigation Jump to search
(Created page with "Category:Scripting Category:Papyrus Category:SKSE '''SKSE Member of:''' SoulGem Script Gets the size of a soul held in the soul gem as int value. (This functi...")
 
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:


Gets the size of a soul held in the soul gem as int value. (This function requires SKSE)<br>
Gets the size of a soul held in the soul gem as int value. (This function requires SKSE)<br>
'''In SKSE 2.2.3 this function is currently broken.''' As confirmed by Ian Patterson, it returns the size of a soul gem instead of held soul size due to incorrect binding.


== Syntax ==
== Syntax ==
Line 20: Line 19:
== Examples ==
== Examples ==
<source lang="papyrus">
<source lang="papyrus">
; note, that function is currently broken, the following syntax is deductive
int soulSize = mySoulGem.GetSoulSize()
int soulSize = mySoulGem.GetSoulSize()
</source>
</source>
== Notes ==
* '''In SKSE < 2.2.4 this function is broken.''' As confirmed by Ian Patterson, the function returns the size of a soul gem instead of the soul size, due to incorrect binding. The bug was fixed in 2.2.4.


== See Also ==
== See Also ==
*[[GetGemSize - SoulGem]]
*[[GetGemSize - SoulGem]]

Latest revision as of 15:58, 7 June 2024

SKSE Member of: SoulGem Script

Gets the size of a soul held in the soul gem as int value. (This function requires SKSE)

Syntax[edit | edit source]

int Function GetSoulSize() native

Parameters[edit | edit source]

  • None

Return Value[edit | edit source]

The size of a soul the gem is holding as int value.

Examples[edit | edit source]

int soulSize = mySoulGem.GetSoulSize()

Notes[edit | edit source]

  • In SKSE < 2.2.4 this function is broken. As confirmed by Ian Patterson, the function returns the size of a soul gem instead of the soul size, due to incorrect binding. The bug was fixed in 2.2.4.

See Also[edit | edit source]