Xordac: 1 revision imported

2017-10-23T23:23:24Z

1 revision imported

New page

=Module Function Category=

Functions used to deal with modules.

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[ActivatePortal | ActivatePortal ]]
| Send a player's client to a new server, where the player's character will log in.
|-
|
[[aGetPLocalInt | aGetPLocalInt ]]
| Scans through the PC's party and returns the largest value stored on a character.
|-
|
[[aSetPLocalInt | aSetPLocalInt ]]
| Sets a local integer on each of the party members.
|-
|
[[DoSinglePlayerAutoSave | DoSinglePlayerAutoSave ]]
| Saves a single player game.
|-
|
[[EndGame | EndGame ]]
| Ends the currently running game.
|-
|
[[GetCalendarDay | GetCalendarDay ]]
| Retrieves the current in-game calendar day.
|-
|
[[GetCalendarMonth | GetCalendarMonth ]]
| Determines the current in-game calendar month.
|-
|
[[GetCalendarYear | GetCalendarYear ]]
| Determine the current in-game calendar year.
|-
|
[[GetEnteringObject | GetEnteringObject ]]
| Gets the object that last opened or entered the calling object.
|-
|
[[GetExitingObject | GetExitingObject ]]
| Get the object that last left the calling object.
|-
|
[[GetModule | GetModule ]]
| Gets the object describing the module.
|-
|
[[GetModuleItemAcquired | GetModuleItemAcquired ]]
| Get the item acquired on an OnAcquiredItem event.
|-
|
[[GetModuleItemAcquiredBy | GetModuleItemAcquiredBy ]]
| Retrieves an object that acquired a module item.
|-
|
[[GetModuleItemAcquiredFrom | GetModuleItemAcquiredFrom ]]
| Get the last owner of the item acquired on an OnAcquiredItem event.
|-
|
[[GetModuleItemAcquiredStackSize | GetModuleItemAcquiredStackSize ]]
| Determines the stack size of an item belonging to a module that was just acquired.
|-
|
[[GetModuleItemLost | GetModuleItemLost ]]
| Get the object that was dropped on an OnUnAcquiredItem event.
|-
|
[[GetModuleItemLostBy | GetModuleItemLostBy ]]
| Get the creature that lost the item on an OnUnAcquiredItem event.
|-
|
[[GetModuleName | GetModuleName ]]
| Get the module name.
|-
|
[[GetModuleXPScale | GetModuleXPScale ]]
| Get the XP scale being used for the module.
|-
|
[[GetPLocalInt | GetPLocalInt ]]
| Determines the value of a locally stored variable from any PC in a party.
|-
|
[[GetStartingLocation | GetStartingLocation ]]
| Determines the starting location of the module.
|-
|
[[SetAreaTransitionBMP | SetAreaTransitionBMP ]]
| Sets the graphic shown when a PC moves between two different areas in a module.
|-
|
[[SetModuleXPScale | SetModuleXPScale ]]
| Set the XP scale used by the module.
|-
|
[[SetPLocalInt | SetPLocalInt ]]
| Sets a variable that remains attached to a PC party.
|-
|
[[StartNewModule | StartNewModule ]]
| Moves the existing players to a new module.
|}

----
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Module Functions - Revision history

Xordac: 1 revision imported