Difference between revisions of "RegisterForActorAction - Form"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>CraftySentinel
m (Added Missing SKSE Category)
imported>CraftySentinel
m (Changed Format A little for easier Reading.)
Line 6: Line 6:


Registers the calling form to listen for the specified actor action via [[OnActorAction - Form|OnActorAction]].
Registers the calling form to listen for the specified actor action via [[OnActorAction - Form|OnActorAction]].
== Syntax ==
=== Syntax ===
<source lang="papyrus">Function RegisterForActorAction(int actionType) Native</source>
<source lang="papyrus">Function RegisterForActorAction(int actionType) Native</source>


 
=== Parameters ===
== Examples ==
<source lang="papyrus">
RegisterforActorAction(0);Registers the form for Weapon Swings
</source>
 
== Parameters ==
*actionType - The following integers are valid:
*actionType - The following integers are valid:
** 0 - Weapon Swing (Melee weapons that are swung including Hand to Hand.)
** 0 - Weapon Swing (Melee weapons that are swung including Hand to Hand.)
Line 28: Line 22:
** 9 - Sheathe Begin.
** 9 - Sheathe Begin.
** 10 - Sheathe End.
** 10 - Sheathe End.
=== Examples ===
<source lang="papyrus">
RegisterforActorAction(0);Registers the form for Weapon Swings
</source>


== Notes ==
== Notes ==
*This function only registers for actions performed by the player's actor, while it can be used on any form it will always be the player's actor's actions that are being registered.
*This function only registers for actions performed by the player's actor, while it can be used on any form it will always be the player's actor's actions that are being registered.


== See Also ==
== See Also ==

Revision as of 01:26, 26 August 2013

SKSE Member of: Form Script

Registers the calling form to listen for the specified actor action via OnActorAction.

Syntax

Function RegisterForActorAction(int actionType) Native

Parameters

  • actionType - The following integers are valid:
    • 0 - Weapon Swing (Melee weapons that are swung including Hand to Hand.)
    • 1 - Spell Cast (Spells and staves).
    • 2 - Spell Fire (Spells and staves).
    • 3 - Voice Cast.
    • 4 - Voice Fire.
    • 5 - Bow Draw.
    • 6 - Bow Release.
    • 7 - Draw Begin.
    • 8 - Draw End.
    • 9 - Sheathe Begin.
    • 10 - Sheathe End.

Examples

RegisterforActorAction(0);Registers the form for Weapon Swings

Notes

  • This function only registers for actions performed by the player's actor, while it can be used on any form it will always be the player's actor's actions that are being registered.

See Also