Category:Module Functions

From NWN Lexicon
Jump to: navigation, search

Module Function Category

Functions used to deal with modules.



Functions

Name Brief Description

ActivatePortal

Send a player's client to a new server, where the player's character will log in.

aGetPLocalInt

Scans through the PC's party and returns the largest value stored on a character.

aSetPLocalInt

Sets a local integer on each of the party members.

DoSinglePlayerAutoSave

Saves a single player game.

EndGame

Ends the currently running game.

GetCalendarDay

Retrieves the current in-game calendar day.

GetCalendarMonth

Determines the current in-game calendar month.

GetCalendarYear

Determine the current in-game calendar year.

GetEnteringObject

Gets the object that last opened or entered the calling object.

GetExitingObject

Get the object that last left the calling object.

GetModule

Gets the object describing the module.

GetModuleItemAcquired

Get the item acquired on an OnAcquiredItem event.

GetModuleItemAcquiredBy

Retrieves an object that acquired a module item.

GetModuleItemAcquiredFrom

Get the last owner of the item acquired on an OnAcquiredItem event.

GetModuleItemAcquiredStackSize

Determines the stack size of an item belonging to a module that was just acquired.

GetModuleItemLost

Get the object that was dropped on an OnUnAcquiredItem event.

GetModuleItemLostBy

Get the creature that lost the item on an OnUnAcquiredItem event.

GetModuleName

Get the module name.

GetModuleXPScale

Get the XP scale being used for the module.

GetPLocalInt

Determines the value of a locally stored variable from any PC in a party.

GetStartingLocation

Determines the starting location of the module.

SetAreaTransitionBMP

Sets the graphic shown when a PC moves between two different areas in a module.

SetModuleXPScale

Set the XP scale used by the module.

SetPLocalInt

Sets a variable that remains attached to a PC party.

StartNewModule

Moves the existing players to a new module.