Table of Contents

Class NetImmerseScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from NetImmerse.psc.

Note that only local transforms can be set as the world transform is computed based on the entire hierarchy rather than a single node 

public static class NetImmerseScript
Inheritance
NetImmerseScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

GetNodeLocalPosition(IObjectReference, string, IReadOnlyCollection<float>, bool)

returns the node's local position into the specify array, must be size of 3

public static Task<bool> GetNodeLocalPosition(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetNodeLocalPositionX(IObjectReference, string, bool) 

public static Task<float> GetNodeLocalPositionX(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeLocalPositionY(IObjectReference, string, bool) 

public static Task<float> GetNodeLocalPositionY(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeLocalPositionZ(IObjectReference, string, bool) 

public static Task<float> GetNodeLocalPositionZ(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeLocalRotationEuler(IObjectReference, string, IReadOnlyCollection<float>, bool)

returns the euler rotation of the node into the specified array, must be size of 3

public static Task<bool> GetNodeLocalRotationEuler(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetNodeLocalRotationMatrix(IObjectReference, string, IReadOnlyCollection<float>, bool)

returns the matrix rotation of the node into the specified array, must be size of 9

public static Task<bool> GetNodeLocalRotationMatrix(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetNodePositionX(IObjectReference, string, bool) 

public static Task<float> GetNodePositionX(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodePositionY(IObjectReference, string, bool) 

public static Task<float> GetNodePositionY(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodePositionZ(IObjectReference, string, bool) 

public static Task<float> GetNodePositionZ(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeScale(IObjectReference, string, bool) 

public static Task<float> GetNodeScale(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeWorldPosition(IObjectReference, string, IReadOnlyCollection<float>, bool)

returns the node's world position into the specify array, must be size of 3

public static Task<bool> GetNodeWorldPosition(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetNodeWorldPositionX(IObjectReference, string, bool) 

public static Task<float> GetNodeWorldPositionX(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeWorldPositionY(IObjectReference, string, bool) 

public static Task<float> GetNodeWorldPositionY(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeWorldPositionZ(IObjectReference, string, bool) 

public static Task<float> GetNodeWorldPositionZ(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<float>

GetNodeWorldRotationEuler(IObjectReference, string, IReadOnlyCollection<float>, bool)

Euler Rotation in DEGREES (heading, attitude, bank) returns the euler rotation of the node into the specified array, must be size of 3

public static Task<bool> GetNodeWorldRotationEuler(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetNodeWorldRotationMatrix(IObjectReference, string, IReadOnlyCollection<float>, bool)

Matrix Rotation in RADIANS returns the matrix rotation of the node into the specified array, must be size of 9

public static Task<bool> GetNodeWorldRotationMatrix(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetRelativeNodePosition(IObjectReference, string, string, IReadOnlyCollection<float>, bool)

returns the node's relative world position of nodeB minus nodeA into the specify array, must be size of 3

public static Task<bool> GetRelativeNodePosition(IObjectReference @ref, string nodeA, string nodeB, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
nodeA string
nodeB string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

GetRelativeNodePositionX(IObjectReference, string, string, bool) 

public static Task<float> GetRelativeNodePositionX(IObjectReference @ref, string nodeA, string nodeB, bool firstPerson)

Parameters

ref IObjectReference
nodeA string
nodeB string
firstPerson bool

Returns

Task<float>

GetRelativeNodePositionY(IObjectReference, string, string, bool) 

public static Task<float> GetRelativeNodePositionY(IObjectReference @ref, string nodeA, string nodeB, bool firstPerson)

Parameters

ref IObjectReference
nodeA string
nodeB string
firstPerson bool

Returns

Task<float>

GetRelativeNodePositionZ(IObjectReference, string, string, bool) 

public static Task<float> GetRelativeNodePositionZ(IObjectReference @ref, string nodeA, string nodeB, bool firstPerson)

Parameters

ref IObjectReference
nodeA string
nodeB string
firstPerson bool

Returns

Task<float>

HasNode(IObjectReference, string, bool)

Return whether the object has the particular node

public static Task<bool> HasNode(IObjectReference @ref, string node, bool firstPerson)

Parameters

ref IObjectReference
node string
firstPerson bool

Returns

Task<bool>

SetNodeLocalPosition(IObjectReference, string, IReadOnlyCollection<float>, bool)

sets the node's local position of the specified array, must be size of 3

public static Task<bool> SetNodeLocalPosition(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

SetNodeLocalPositionX(IObjectReference, string, float, bool) 

public static Task SetNodeLocalPositionX(IObjectReference @ref, string node, float x, bool firstPerson)

Parameters

ref IObjectReference
node string
x float
firstPerson bool

Returns

Task

SetNodeLocalPositionY(IObjectReference, string, float, bool) 

public static Task SetNodeLocalPositionY(IObjectReference @ref, string node, float y, bool firstPerson)

Parameters

ref IObjectReference
node string
y float
firstPerson bool

Returns

Task

SetNodeLocalPositionZ(IObjectReference, string, float, bool) 

public static Task SetNodeLocalPositionZ(IObjectReference @ref, string node, float z, bool firstPerson)

Parameters

ref IObjectReference
node string
z float
firstPerson bool

Returns

Task

SetNodeLocalRotationEuler(IObjectReference, string, IReadOnlyCollection<float>, bool)

sets the euler rotation for the node of the specified array, must be size of 3

public static Task<bool> SetNodeLocalRotationEuler(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

SetNodeLocalRotationMatrix(IObjectReference, string, IReadOnlyCollection<float>, bool)

sets the matrix rotation for the node of the specified array, must be size of 9

public static Task<bool> SetNodeLocalRotationMatrix(IObjectReference @ref, string node, IReadOnlyCollection<float> @in, bool firstPerson)

Parameters

ref IObjectReference
node string
in IReadOnlyCollection<float>
firstPerson bool

Returns

Task<bool>

SetNodePositionX(IObjectReference, string, float, bool) 

[Obsolete("NetImmerse.psc deprecates SetNodePositionX, which calls SetNodeLocalPositionX with the same arguments. Use SetNodeLocalPositionX instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task SetNodePositionX(IObjectReference @ref, string node, float x, bool firstPerson)

Parameters

ref IObjectReference
node string
x float
firstPerson bool

Returns

Task

SetNodePositionY(IObjectReference, string, float, bool) 

[Obsolete("NetImmerse.psc deprecates SetNodePositionY, which calls SetNodeLocalPositionY with the same arguments. Use SetNodeLocalPositionY instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task SetNodePositionY(IObjectReference @ref, string node, float y, bool firstPerson)

Parameters

ref IObjectReference
node string
y float
firstPerson bool

Returns

Task

SetNodePositionZ(IObjectReference, string, float, bool) 

[Obsolete("NetImmerse.psc deprecates SetNodePositionZ, which calls SetNodeLocalPositionZ with the same arguments. Use SetNodeLocalPositionZ instead.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task SetNodePositionZ(IObjectReference @ref, string node, float z, bool firstPerson)

Parameters

ref IObjectReference
node string
z float
firstPerson bool

Returns

Task

SetNodeScale(IObjectReference, string, float, bool) 

public static Task SetNodeScale(IObjectReference @ref, string node, float scale, bool firstPerson)

Parameters

ref IObjectReference
node string
scale float
firstPerson bool

Returns

Task

SetNodeTextureSet(IObjectReference, string, TextureSet, bool)

Sets a NiTriShape's textures by name of the Nif node

public static Task SetNodeTextureSet(IObjectReference @ref, string node, TextureSet tSet, bool firstPerson)

Parameters

ref IObjectReference
node string
tSet TextureSet
firstPerson bool

Returns

Task