NWNX:EE  8193.36.12
nwnx_player.nss File Reference
#include "nwnx"

Go to the source code of this file.

Classes

struct  NWNX_Player_QuickBarSlot
 A quickbar slot. More...
 
struct  NWNX_Player_JournalEntry
 A journal entry. More...
 

Functions

void NWNX_Player_ForcePlaceableExamineWindow (object player, object placeable)
 Force display placeable examine window for player. More...
 
void NWNX_Player_ForcePlaceableInventoryWindow (object player, object placeable)
 Force opens the target object's inventory for the player. More...
 
void NWNX_Player_StartGuiTimingBar (object player, float seconds, string script="", int type=NWNX_PLAYER_TIMING_BAR_CUSTOM)
 Starts displaying a timing bar. More...
 
void NWNX_Player_StopGuiTimingBar (object player, string script="")
 Stop displaying a timing bar. More...
 
void NWNX_Player_SetAlwaysWalk (object player, int bWalk=TRUE)
 Sets whether the player should always walk when given movement commands. More...
 
struct NWNX_Player_QuickBarSlot NWNX_Player_GetQuickBarSlot (object player, int slot)
 Gets the player's quickbar slot info. More...
 
void NWNX_Player_SetQuickBarSlot (object player, int slot, struct NWNX_Player_QuickBarSlot qbs)
 Sets the player's quickbar slot info. More...
 
string NWNX_Player_GetBicFileName (object player)
 Get the name of the .bic file associated with the player's character. More...
 
void NWNX_Player_ShowVisualEffect (object player, int effectId, vector position, float scale=1.0f, vector translate=[], vector rotate=[])
 Plays the VFX at the target position in current area for the given player only. More...
 
void NWNX_Player_MusicBackgroundChangeDay (object player, int track)
 Changes the daytime music track for the given player only. More...
 
void NWNX_Player_MusicBackgroundChangeNight (object player, int track)
 Changes the nighttime music track for the given player only. More...
 
void NWNX_Player_MusicBackgroundStart (object player)
 Starts the background music for the given player only. More...
 
void NWNX_Player_MusicBackgroundStop (object player)
 Stops the background music for the given player only. More...
 
void NWNX_Player_MusicBattleChange (object player, int track)
 Changes the battle music track for the given player only. More...
 
void NWNX_Player_MusicBattleStart (object player)
 Starts the battle music for the given player only. More...
 
void NWNX_Player_MusicBattleStop (object player)
 Stops the battle music for the given player only. More...
 
void NWNX_Player_PlaySound (object player, string sound, object target=OBJECT_INVALID)
 Play a sound at the location of target for the given player only. More...
 
void NWNX_Player_SetPlaceableUsable (object player, object placeable, int usable)
 Toggle a placeable's usable flag for the given player only. More...
 
void NWNX_Player_SetRestDuration (object player, int duration)
 Override player's rest duration. More...
 
void NWNX_Player_ApplyInstantVisualEffectToObject (object player, object target, int visualeffect, float scale=1.0f, vector translate=[], vector rotate=[])
 Apply visualeffect to target that only player can see. More...
 
void NWNX_Player_UpdateCharacterSheet (object player)
 Refreshes the players character sheet. More...
 
void NWNX_Player_OpenInventory (object player, object target, int open=TRUE)
 Allows player to open target's inventory. More...
 
string NWNX_Player_GetAreaExplorationState (object player, object area)
 Get player's area exploration state. More...
 
void NWNX_Player_SetAreaExplorationState (object player, object area, string str)
 Set player's area exploration state. More...
 
void NWNX_Player_SetRestAnimation (object oPlayer, int nAnimation)
 Override player's rest animation. More...
 
void NWNX_Player_SetObjectVisualTransformOverride (object oPlayer, object oObject, int nTransform, float fValue)
 Override a visual transform on the given object that only player will see. More...
 
void NWNX_Player_ApplyLoopingVisualEffectToObject (object player, object target, int visualeffect)
 Apply a looping visualeffect to a target that only player can see. More...
 
void NWNX_Player_SetPlaceableNameOverride (object player, object placeable, string name)
 Override the name of placeable for player only. More...
 
int NWNX_Player_GetQuestCompleted (object player, string sQuestName)
 Gets whether a quest has been completed by a player. More...
 
void NWNX_Player_SetPersistentLocation (string sCDKeyOrCommunityName, string sBicFileName, object oWP, int bFirstConnectOnly=TRUE)
 Place waypoints on module load representing where a PC should start. More...
 
void NWNX_Player_UpdateItemName (object oPlayer, object oItem)
 Force an item name to be updated. More...
 
int NWNX_Player_PossessCreature (object oPossessor, object oPossessed, int bMindImmune=TRUE, int bCreateDefaultQB=FALSE)
 Possesses a creature by temporarily making them a familiar. More...
 
int NWNX_Player_GetPlatformId (object oPlayer)
 Returns the platform ID of the given player (NWNX_PLAYER_PLATFORM_*) More...
 
int NWNX_Player_GetLanguage (object oPlayer)
 Returns the game language of the given player (uses NWNX_DIALOG_LANGUAGE_*) More...
 
void NWNX_Player_SetResManOverride (object oPlayer, int nResType, string sOldResName, string sNewResName)
 Override sOldResName with sNewResName of nResType for oPlayer. More...
 
void NWNX_Player_SetCustomToken (object oPlayer, int nCustomTokenNumber, string sTokenValue)
 Set nCustomTokenNumber to sTokenValue for oPlayer only. More...
 
void NWNX_Player_SetCreatureNameOverride (object oPlayer, object oCreature, string sName)
 Override the name of creature for player only. More...
 
void NWNX_Player_FloatingTextStringOnCreature (object oPlayer, object oCreature, string sText, int bChatWindow=TRUE)
 Display floaty text above oCreature for oPlayer only. More...
 
void NWNX_Player_ToggleDM (object oPlayer, int bIsDM)
 Toggle oPlayer's PlayerDM status. More...
 
void NWNX_Player_SetObjectMouseCursorOverride (object oPlayer, object oObject, int nCursor)
 Override the mouse cursor of oObject for oPlayer only. More...
 
void NWNX_Player_SetObjectHiliteColorOverride (object oPlayer, object oObject, int nColor)
 Override the hilite color of oObject for oPlayer only. More...
 
void NWNX_Player_RemoveEffectFromTURD (object oPlayer, string sEffectTag)
 Remove effects with sEffectTag from oPlayer's TURD. More...
 
void NWNX_Player_SetSpawnLocation (object oPlayer, location locSpawn)
 Set the location oPlayer will spawn when logging in to the server. More...
 
void NWNX_Player_SendDMAllCreatorLists (object oPlayer)
 Resends palettes to a DM. More...
 
int NWNX_Player_AddCustomJournalEntry (object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate=0)
 Give a custom journal entry to oPlayer. More...
 
struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry (object oPlayer, string questTag)
 Returns a struct containing a journal entry that can then be modified. More...
 
void NWNX_Player_CloseStore (object oPlayer)
 Closes any store oPlayer may have open. More...
 
void NWNX_Player_SetTlkOverride (object oPlayer, int nStrRef, string sOverride, int bRestoreGlobal=TRUE)
 Override nStrRef from the TlkTable with sOverride for oPlayer only. More...
 
void NWNX_Player_ReloadTlk (object oPlayer)
 Make the player reload it's TlkTable. More...
 
void NWNX_Player_UpdateWind (object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch)
 Update wind for oPlayer only. More...
 
void NWNX_Player_UpdateSkyBox (object oPlayer, int nSkyBox)
 Update the SkyBox for oPlayer only. More...
 
void NWNX_Player_UpdateFogColor (object oPlayer, int nSunFogColor, int nMoonFogColor)
 Update Sun and Moon Fog Color for oPlayer only. More...
 
void NWNX_Player_UpdateFogAmount (object oPlayer, int nSunFogAmount, int nMoonFogAmount)
 Update Sun and Moon Fog Amount for oPlayer only. More...
 
object NWNX_Player_GetGameObject (object oPlayer)
 Return's the currently-possessed game object of a player. More...
 
void NWNX_Player_SetObjectUiDiscoveryMaskOverride (object oPlayer, object oObject, int nMask)
 Override the ui discovery mask of oObject for oPlayer only. More...
 
void NWNX_Player_SendPartyInvite (object oPlayer, object oInviter, int bForceInvite=FALSE, int bHideDialog=FALSE)
 Send a party invite from oInviter to oPlayer. More...
 
object NWNX_Player_GetTURD (object oPlayer)
 Get the TURD for oPlayer. More...
 
void NWNX_Player_ReloadColorPalettes (object oPlayer)
 Reloads the color palettes for oPlayer. More...
 

Variables

Timing Bar Types

The various types of timing bars.

const int NWNX_PLAYER_TIMING_BAR_TRAP_FLAG = 1
 
const int NWNX_PLAYER_TIMING_BAR_TRAP_RECOVER = 2
 
const int NWNX_PLAYER_TIMING_BAR_TRAP_DISARM = 3
 
const int NWNX_PLAYER_TIMING_BAR_TRAP_EXAMINE = 4
 
const int NWNX_PLAYER_TIMING_BAR_TRAP_SET = 5
 
const int NWNX_PLAYER_TIMING_BAR_REST = 6
 
const int NWNX_PLAYER_TIMING_BAR_UNLOCK = 7
 
const int NWNX_PLAYER_TIMING_BAR_LOCK = 8
 
const int NWNX_PLAYER_TIMING_BAR_CUSTOM = 10
 
Platform IDs

const int NWNX_PLAYER_PLATFORM_INVALID = 0
 
const int NWNX_PLAYER_PLATFORM_WINDOWS_X86 = 1
 
const int NWNX_PLAYER_PLATFORM_WINDOWS_X64 = 2
 
const int NWNX_PLAYER_PLATFORM_LINUX_X86 = 10
 
const int NWNX_PLAYER_PLATFORM_LINUX_X64 = 11
 
const int NWNX_PLAYER_PLATFORM_LINUX_ARM32 = 12
 
const int NWNX_PLAYER_PLATFORM_LINUX_ARM64 = 13
 
const int NWNX_PLAYER_PLATFORM_MAC_X86 = 20
 
const int NWNX_PLAYER_PLATFORM_MAC_X64 = 21
 
const int NWNX_PLAYER_PLATFORM_IOS = 30
 
const int NWNX_PLAYER_PLATFORM_ANDROID_ARM32 = 40
 
const int NWNX_PLAYER_PLATFORM_ANDROID_ARM64 = 41
 
const int NWNX_PLAYER_PLATFORM_ANDROID_X64 = 42
 
const int NWNX_PLAYER_PLATFORM_NINTENDO_SWITCH = 50
 
const int NWNX_PLAYER_PLATFORM_MICROSOFT_XBOXONE = 60
 
const int NWNX_PLAYER_PLATFORM_SONY_PS4 = 70