Category:Action on Object Functions

2014-02-17T00:40:49Z

76.126.70.158: closed the unclosed 'functions' category ref

=Action on Object Function Category=

Functions used to perform specific actions upon a certain object.

 

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActionAttack | ActionAttack ]]
| Initiates an attack between two creatures or a creature and an object.
|-
|
[[ActionCastSpellAtLocation | ActionCastSpellAtLocation ]]
| Cast a spell at a specific location.
|-
|
[[ActionCastSpellAtObject | ActionCastSpellAtObject ]]
| Cast a spell at an object.
|-
|
[[ActionCloseDoor | ActionCloseDoor ]]
| An action that causes an object to close a door.
|-
|
[[ActionCounterSpell | ActionCounterSpell ]]
| Causes the caller to enter the counterspell modal combat mode.
|-
|
[[ActionDoCommand | ActionDoCommand ]]
| Inserts a command into the Action Queue.
|-
|
[[ActionEquipItem | ActionEquipItem ]]
| Puts an item in possession into an inventory slot.
|-
|
[[ActionEquipMostDamagingMelee | ActionEquipMostDamagingMelee ]]
| Causes the calling creature to equip its most damaging weapon.
|-
|
[[ActionEquipMostDamagingRanged | ActionEquipMostDamagingRanged ]]
| Causes the calling creature to equip the most damaging ranged weapon in its inventory.
|-
|
[[ActionEquipMostEffectiveArmor | ActionEquipMostEffectiveArmor ]]
| Causes the calling creature to equip the best armor in its inventory.
|-
|
[[ActionForceFollowObject | ActionForceFollowObject ]]
| Forces an NPC to follow an object.
|-
|
[[ActionForceMoveToLocation | ActionForceMoveToLocation ]]
| Attempts to move an NPC to a location.
|-
|
[[ActionForceMoveToObject | ActionForceMoveToObject ]]
| Attempts to move an NPC to a certain distance of a target object even if a clear path doesn't exist.
|-
|
[[ActionGiveItem | ActionGiveItem ]]
| Gives a specified item to a target creature.
|-
|
[[ActionInteractObject | ActionInteractObject ]]
| Causes a creature or PC to use an object.
|-
|
[[ActionJumpToLocation | ActionJumpToLocation ]]
| Instantly sends the calling object to the position of locTarget.
|-
|
[[ActionJumpToObject | ActionJumpToObject ]]
| Teleports the calling object to the nearest valid location by the target.
|-
|
[[ActionLockObject | ActionLockObject ]]
| An action that will cause a creature to lock a door or other unlocked object.
|-
|
[[ActionMoveToLocation | ActionMoveToLocation ]]
| Moves an NPC to a location before executing further actions in the action queue.
|-
|
[[ActionMoveToObject | ActionMoveToObject ]]
| Cause action subject to move to a certain distance of a target object.
|-
|
[[ActionOpenDoor | ActionOpenDoor ]]
| An action that will cause a creature to open a door.
|-
|
[[ActionPauseConversation | ActionPauseConversation ]]
| Pause the current conversation.
|-
|
[[ActionPickUpItem | ActionPickUpItem ]]
| Causes subject to run to an item and place it in inventory.
|-
|
[[ActionPlayAnimation | ActionPlayAnimation ]]
| Plays an animation (fire and forget, looping, or placeable) before executing the next action in the queue.
|-
|
[[ActionPsionicCharm | ActionPsionicCharm ]]
| Attempts a confusion attack on target.
|-
|
[[ActionPsionicMB | ActionPsionicMB ]]
| Attempts a stun attack in a cone shaped spell out to 15.0 meters.
|-
|
[[ActionPutDownItem | ActionPutDownItem ]]
| Causes the subject to place an item on the ground at it's feet.
|-
|
[[ActionRandomWalk | ActionRandomWalk ]]
| Causes the subject to walk to a random location close to itself.
|-
|
[[ActionRest | ActionRest ]]
| Causes the creature to rest.
|-
|
[[ActionResumeConversation | ActionResumeConversation ]]
| Resume a conversation after it has been paused.
|-
|
[[ActionSit | ActionSit ]]
| Causes a creature to attempt to sit on something.
|-
|
[[ActionSpeakString | ActionSpeakString ]]
| Causes an object to speak.
|-
|
[[ActionSpeakStringByStrRef | ActionSpeakStringByStrRef ]]
| Causes the creature to speak a translated string.
|-
|
[[ActionStartConversation | ActionStartConversation ]]
| NPC action to start a conversation with a PC
|-
|
[[ActionTakeItem | ActionTakeItem ]]
| Takes an item from an object
|-
|
[[ActionUnequipItem | ActionUnequipItem ]]
| Makes the executing creature unequip an object and place it in their inventory.
|-
|
[[ActionUnlockObject | ActionUnlockObject ]]
| Causes a creature to unlock a door or other locked object.
|-
|
[[ActionUseFeat | ActionUseFeat ]]
| Causes an NPC to use a feat on oTarget.
|-
|
[[ActionUseSkill | ActionUseSkill ]]
| Causes a creature to attempt to use a skill on another object.
|-
|
[[ActionUseTalentOnObject | ActionUseTalentOnObject ]]
| Use tChosenTalent on oTarget.
|-
|
[[ActionWait | ActionWait ]]
| Adds a wait action to an objects queue.
|-
|
[[AnimActionChallengeIntruder | AnimActionChallengeIntruder ]]
| Challenges a PC from an NPC if they have not yet been challenged.
|-
|
[[AssignCommand | AssignCommand ]]
| Assigns an action command to a creature to act on.
|-
|
[[BeginConversation | BeginConversation ]]
| Attempts to start a conversation immediately.
|-
|
[[CheckCurrentModes | CheckCurrentModes ]]
| Check to see if we should switch on or off the detect or stealth modes.
|-
|
[[CheckIsCivilized | CheckIsCivilized ]]
| Marks the caller as civilized based on its racialtype.
|-
|
[[ClearActions | ClearActions ]]
|
This is a wrapper for [[ClearAllActions | ClearAllActions ]].
|-
|
[[ClearAllActions | ClearAllActions ]]
| Clears currently queued actions from the calling object.
|-
|
[[ClearAssociateActions | ClearAssociateActions ]]
| Clear the actions of one of each type of the PC's associates
|-
|
[[ClearNearbyFriendActions | ClearNearbyFriendActions ]]
| Clears the actions of a creature and all nearby friends
|-
|
[[DayToNight | DayToNight ]]
| Changes the current Day/Night cycle for this player to night
|-
|
[[DelayCommand | DelayCommand ]]
| Delays an assigned action for a period of time.
|-
|
[[DestroyObject | DestroyObject ]]
| Destroy an object.
|-
|
[[DoDoorAction | DoDoorAction ]]
| Does specific action to target door.
|-
|
[[DoPlaceableObjectAction | DoPlaceableObjectAction ]]
| Starts a placeable object special action.
|-
|
[[EquipAppropriateWeapons | EquipAppropriateWeapons ]]
| Cause a creature to ready an appropriate weapon.
|-
|
[[EventActivateItem | EventActivateItem ]]
| Returns an event of type Activate Item.
|-
|
[[EventConversation | EventConversation ]]
| Returns an event of type Conversation.
|-
|
[[EventUserDefined | EventUserDefined ]]
| Returns an event of the type nUserDefinedEventNumber.
|-
|
[[ForceRest | ForceRest ]]
| Fully restores a creature
|-
|
[[GetCurrentAction | GetCurrentAction ]]
| Returns the currently executing Action.
|-
|
[[GetDamageDealtByType | GetDamageDealtByType ]]
| Determines the amount of damage of a specific type dealt to an object.
|-
|
[[GetEnteringObject | GetEnteringObject ]]
| Gets the object that last opened or entered the calling object.
|-
|
[[GetExitingObject | GetExitingObject ]]
| Get the object that last left the calling object.
|-
|
[[GetIdentified | GetIdentified ]]
| Determines whether an object has been identified.
|-
|
[[GetIsPlaceableObjectActionPossible | GetIsPlaceableObjectActionPossible ]]
| Check whether a given action is valid for a given placeable object.
|-
|
[[GetItemActivated | GetItemActivated ]]
| Retrieve the item which was activated to trigger the module's OnActivateItem event.
|-
|
[[GetItemActivatedTarget | GetItemActivatedTarget ]]
| Determine the activated item's target.
|-
|
[[GetItemActivatedTargetLocation | GetItemActivatedTargetLocation ]]
| Determine the location of the activated item's target.
|-
|
[[GetItemActivator | GetItemActivator ]]
| Retrieve the creature which activated an item.
|-
|
[[GetLastClosedBy | GetLastClosedBy ]]
| Determine which creature closed a door or placeable.
|-
|
[[GetLastDisarmed | GetLastDisarmed ]]
| Determine who last disarmed a trapped trigger, door or placeable object.
|-
|
[[GetLockKeyRequired | GetLockKeyRequired ]]
| Check whether an object requires a specific key to be unlocked.
|-
|
[[GiveGoldToCreature | GiveGoldToCreature ]]
| Creates the specified amount of gold on the creature.
|-
|
[[GiveXPToCreature | GiveXPToCreature ]]
| Gives an amount of experience to the specified creature.
|-
|
[[JumpToLocation | JumpToLocation ]]
| This is a command to move instantly to the location referenced by lLocation.
|-
|
[[JumpToObject | JumpToObject ]]
| Teleports the calling object to the nearest valid location by the target.
|-
|
[[KillAndExplode | KillAndExplode ]]
| Kill and leave an exploding corpse.
|-
|
[[KillAndReplaceDecay | KillAndReplaceDecay ]]
| Kill and leave a decorative corpse that will decay after a short while.
|-
|
[[KillAndReplaceDecorative | KillAndReplaceDecorative ]]
| Kill and leave a purely decorative corpse (no name, not raiseable).
|-
|
[[KillAndReplaceLootable | KillAndReplaceLootable ]]
| Kill and leave a lootable corpse.
|-
|
[[KillAndReplaceRaiseable | KillAndReplaceRaiseable ]]
| Kill and leave a raiseable and selectable corpse.
|-
|
[[KillAndReplaceSelectable | KillAndReplaceSelectable ]]
| Kill and leave a selectable corpse.
|-
|
[[MakeDrunk | MakeDrunk ]]
| Gets a creature drunk.
|-
|
[[MoveToNewLocation | MoveToNewLocation ]]
| Tells the object to move to a new location
|-
|
[[NightToDay | NightToDay ]]
| Changes the current Day/Night cycle for this player to daylight
|-
|
[[PlayConversationAnimation | PlayConversationAnimation ]]
| Makes caller face a PC and play an animation.
|-
|
[[RaiseCorpse | RaiseCorpse ]]
| Raise a given corpse from the dead with the given visual effect.
|-
|
[[RewardPartyGP | RewardPartyGP ]]
| Give gold to PC or PC's entire party
|-
|
[[SetActionMode | SetActionMode ]]
| Sets the status of an action mode on a creature
|-
|
[[SetAnimationCondition | SetAnimationCondition ]]
| Mark that the given creature has the given condition set.
|-
|
[[SetCreatureAppearanceType | SetCreatureAppearanceType ]]
| Change a creature's appearance
|-
|
[[SetColor | SetColor ]]
| Sets the color for the specified color channel.
|-
|
[[SetCreatureBodyPart | SetCreatureBodyPart ]]
| Sets the body part model to be used on the creature specified.
|-
|
[[SetCreatureTailType | SetCreatureTailType ]]
| Sets the tail type of the creature specified.
|-
|
[[SetCreatureHomeWaypoint | SetCreatureHomeWaypoint ]]
| Check for a waypoint marked NW_HOME in the area; if it exists, mark it as the caller's home waypoint.
|-
|
[[SetCreatureWingType | SetCreatureWingType ]]
| Sets the wing type of the creature specified.
|-
|
[[SetCurrentFriend | SetCurrentFriend ]]
| Set a specific creature as the caller's friend.
|-
|
[[SetCurrentInteractionTarget | SetCurrentInteractionTarget ]]
| Set an object as the caller's interactive target.
|-
|
[[SetDescription | SetDescription ]]
| Sets the description of an object.
|-
|
[[SetHardness | SetHardness ]]
| Sets the hardness of a door or placeable.
|-
|
[[SetIsDestroyable | SetIsDestroyable ]]
| Sets whether an object is destroyable.
|-
|
[[SetItemCharges | SetItemCharges ]]
| Sets the number of charges left on a given item.
|-
|
[[SetItemStackSize | SetItemStackSize ]]
| Set the number of items in a given stack.
|-
|
[[SetKeyRequiredFeedback | SetKeyRequiredFeedback ]]
| Set the feedback message that is displayed when trying to unlock the object.
|-
|
[[SetLockKeyRequired | SetLockKeyRequired ]]
| When set the object can not be opened unless the opener possesses the required key.
|-
|
[[SetLockKeyTag | SetLockKeyTag ]]
| Set the key tag required to open the object.
|-
|
[[SetLockLockable | SetLockLockable ]]
| Sets whether or not the object can be locked.
|-
|
[[SetLockLockDC | SetLockLockDC ]]
| Sets the DC for locking the object.
|-
|
[[SetLockUnlockDC | SetLockUnlockDC ]]
| Sets the DC for unlocking the object.
|-
|
[[SetName | SetName ]]
| Set the name of an object.
|-
|
[[SetObjectIsDestroyable | SetObjectIsDestroyable ]]
| Convenience function to set an object to be destroyable.
|-
|
[[SetPortraitId | SetPortraitId ]]
| Change the portrait of the object to use the specified portrait id.
|-
|
[[SetPortraitResRef | SetPortraitResRef ]]
| Change the portrait of the object to use the portrait ResRef.
|-
|
[[SetUseableFlag | SetUseableFlag ]]
| Set a placeable's useable object status.
|-
|
[[ShoutDisturbed | ShoutDisturbed ]]
| Turns NPCs of the container's faction hostile towards the PC that destroyed or opened the container.
|-
|
[[SKIN_SupportEquipSkin | SKIN_SupportEquipSkin ]]
| Forces a creature to equip a skin item in its creature armor inventory slot.
|-
|
[[SoundObjectSetPosition | SoundObjectSetPosition ]]
| Sets the position of a sound object relative to the player(s).
|-
|
[[SoundObjectSetVolume | SoundObjectSetVolume ]]
| This function will set the volume of a placed sound object, great for creating mood effects.
|-
|
[[SplitCreature | SplitCreature ]]
| Handles the "split" functionality of the Ochre Jellies.
|-
|
[[TalentFlee | TalentFlee ]]
| Make the calling object flee from another object.
|}

====See Also====

 
----
author: NWN Lexicon Group, editor: Mistress, contributor: Axe Murderer 
[[Category:Functions]]
[[Category:Function_Categories]]

Prime-WoW Wiki - User contributions [en]

Category:Action on Object Functions