Difference between revisions of "GetSelf"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Henning
(Complete article.)
imported>Tgspy
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/GetSelf GetSelf].
{{Function
|CSWikiPage = GetSelf
|origin = GECK1
|summary = Returns the RefID of the calling reference.  [[GetSelf]] is only useful when this information is accessed externally, or when the scripted reference's RefID needs to be passed as a parameter to a function like [[PushActorAway]]
|alias = this
|example = ref rSelf
set rSelf to GetSelf
player.PushActorAway rSelf 5
}}


Syntax:
==Notes==
  set RefVar to GetSelf
<ul>
<li>While functions that take an implied reference can be cast without needing a variable or call to getself, like so:
<pre>CIOS someSpell</pre>
Doing so may not be clear, and makes the code less portable if moved to a different script that does not support the implied reference. For this reason, modders should prefer the more expressive syntax:
<pre>
ref rSelf
set rSelf to GetSelf
rSelf.CIOS someSpell</pre>
Not only for CIOS, but for all "reference methods" that require a reference, like CIOS.
</li>
<li>[[GetSelf]] will return 0 if called on a reference that has been created dynamically (for example, created via [[PlaceAtMe]], or dropped from an inventory into the game world).
</li>
</ul>
*Using GetSelf in scripts rather than  this will result in GECKPU throwing errors.


Example:
ref target
set RefVar to GetSelf
If RefVar.IsInCombat == 0
  return
Endif
Returns the calling object itself as a reference. Useful for if statements and script effects on targets.


[[Category:Functions]]
[[Category:Functions]]

Latest revision as of 07:47, 13 January 2017

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

Link to TES4 Construction Set Wiki: GetSelf.

A function included in the GECK version 1.1.0.36.

Description

Returns the RefID of the calling reference. GetSelf is only useful when this information is accessed externally, or when the scripted reference's RefID needs to be passed as a parameter to a function like PushActorAway

Syntax

[help]
GetSelf 

Or: 

this

Example

ref rSelf
set rSelf to GetSelf
player.PushActorAway rSelf 5

Notes

  • While functions that take an implied reference can be cast without needing a variable or call to getself, like so: 
    CIOS someSpell

    Doing so may not be clear, and makes the code less portable if moved to a different script that does not support the implied reference. For this reason, modders should prefer the more expressive syntax: 

    ref rSelf
set rSelf to GetSelf
rSelf.CIOS someSpell

    Not only for CIOS, but for all "reference methods" that require a reference, like CIOS.

  • GetSelf will return 0 if called on a reference that has been created dynamically (for example, created via PlaceAtMe, or dropped from an inventory into the game world).
  • Using GetSelf in scripts rather than this will result in GECKPU throwing errors.
Retrieved from "https://geck.uesp.net/w/index.php?title=GetSelf&oldid=7647"