6 const string NWNX_Player =
"NWNX_Player";
140 void NWNX_Player_ShowVisualEffect(
object player,
int effectId, vector position,
float scale=1.0f, vector translate=[], vector rotate=[]);
409 void NWNX_Player_UpdateWind(
object oPlayer, vector vDirection,
float fMagnitude,
float fYaw,
float fPitch);
465 NWNXPushObject(placeable);
466 NWNXPushObject(player);
467 NWNXCall(NWNX_Player,
"ForcePlaceableExamineWindow");
472 NWNXPushObject(placeable);
473 NWNXPushObject(player);
474 NWNXCall(NWNX_Player,
"ForcePlaceableInventoryWindow");
477 void NWNX_Player_INTERNAL_StopGuiTimingBar(
object player,
string script =
"",
int id = -1)
479 int activeId = GetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE");
484 if (
id != -1 &&
id != activeId)
486 DeleteLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE");
487 NWNXPushObject(player);
488 NWNXCall(NWNX_Player,
"StopGuiTimingBar");
491 ExecuteScript(script, player);
497 if (GetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE"))
500 NWNXPushFloat(seconds);
501 NWNXPushObject(player);
502 NWNXCall(NWNX_Player,
"StartGuiTimingBar");
503 int id = GetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ID") + 1;
504 SetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE",
id);
505 SetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ID",
id);
506 DelayCommand(seconds, NWNX_Player_INTERNAL_StopGuiTimingBar(player, script,
id));
511 NWNX_Player_INTERNAL_StopGuiTimingBar(player, script, -1);
517 NWNXPushObject(player);
518 NWNXCall(NWNX_Player,
"SetAlwaysWalk");
525 NWNXPushObject(player);
526 NWNXCall(NWNX_Player,
"GetQuickBarSlot");
527 qbs.oAssociate = NWNXPopObject();
528 qbs.nAssociateType = NWNXPopInt();
529 qbs.nDomainLevel = NWNXPopInt();
530 qbs.nMetaType = NWNXPopInt();
531 qbs.nINTParam1 = NWNXPopInt();
532 qbs.sToolTip = NWNXPopString();
533 qbs.sCommandLine = NWNXPopString();
534 qbs.sCommandLabel = NWNXPopString();
535 qbs.sResRef = NWNXPopString();
536 qbs.nMultiClass = NWNXPopInt();
537 qbs.nObjectType = NWNXPopInt();
538 qbs.oSecondaryItem = NWNXPopObject();
539 qbs.oItem = NWNXPopObject();
545 NWNXPushObject(qbs.
oItem);
559 NWNXPushObject(player);
560 NWNXCall(NWNX_Player,
"SetQuickBarSlot");
565 NWNXPushObject(player);
566 NWNXCall(NWNX_Player,
"GetBicFileName");
567 return NWNXPopString();
572 NWNXPushVector(rotate);
573 NWNXPushVector(translate);
574 NWNXPushFloat(scale);
575 NWNXPushVector(position);
576 NWNXPushInt(effectId);
577 NWNXPushObject(player);
578 NWNXCall(NWNX_Player,
"ShowVisualEffect");
585 NWNXPushObject(player);
586 NWNXCall(NWNX_Player,
"ChangeBackgroundMusic");
593 NWNXPushObject(player);
594 NWNXCall(NWNX_Player,
"ChangeBackgroundMusic");
600 NWNXPushObject(player);
601 NWNXCall(NWNX_Player,
"PlayBackgroundMusic");
607 NWNXPushObject(player);
608 NWNXCall(NWNX_Player,
"PlayBackgroundMusic");
614 NWNXPushObject(player);
615 NWNXCall(NWNX_Player,
"ChangeBattleMusic");
621 NWNXPushObject(player);
622 NWNXCall(NWNX_Player,
"PlayBattleMusic");
628 NWNXPushObject(player);
629 NWNXCall(NWNX_Player,
"PlayBattleMusic");
634 NWNXPushObject(target);
635 NWNXPushString(sound);
636 NWNXPushObject(player);
637 NWNXCall(NWNX_Player,
"PlaySound");
643 NWNXPushObject(placeable);
644 NWNXPushObject(player);
645 NWNXCall(NWNX_Player,
"SetPlaceableUsable");
650 NWNXPushInt(duration);
651 NWNXPushObject(player);
652 NWNXCall(NWNX_Player,
"SetRestDuration");
657 NWNXPushVector(rotate);
658 NWNXPushVector(translate);
659 NWNXPushFloat(scale);
660 NWNXPushInt(visualeffect);
661 NWNXPushObject(target);
662 NWNXPushObject(player);
663 NWNXCall(NWNX_Player,
"ApplyInstantVisualEffectToObject");
668 NWNXPushObject(player);
669 NWNXCall(NWNX_Player,
"UpdateCharacterSheet");
675 NWNXPushObject(target);
676 NWNXPushObject(player);
677 NWNXCall(NWNX_Player,
"OpenInventory");
682 NWNXPushObject(area);
683 NWNXPushObject(player);
684 NWNXCall(NWNX_Player,
"GetAreaExplorationState");
685 return NWNXPopString();
691 NWNXPushObject(area);
692 NWNXPushObject(player);
693 NWNXCall(NWNX_Player,
"SetAreaExplorationState");
698 NWNXPushInt(nAnimation);
699 NWNXPushObject(oPlayer);
700 NWNXCall(NWNX_Player,
"SetRestAnimation");
705 NWNXPushFloat(fValue);
706 NWNXPushInt(nTransform);
707 NWNXPushObject(oObject);
708 NWNXPushObject(oPlayer);
709 NWNXCall(NWNX_Player,
"SetObjectVisualTransformOverride");
714 NWNXPushInt(visualeffect);
715 NWNXPushObject(target);
716 NWNXPushObject(player);
717 NWNXCall(NWNX_Player,
"ApplyLoopingVisualEffectToObject");
722 NWNXPushString(name);
723 NWNXPushObject(placeable);
724 NWNXPushObject(player);
725 NWNXCall(NWNX_Player,
"SetPlaceableNameOverride");
730 NWNXPushString(sQuestName);
731 NWNXPushObject(player);
732 NWNXCall(NWNX_Player,
"GetQuestCompleted");
738 NWNXPushInt(bFirstConnectOnly);
740 NWNXPushString(sBicFileName);
741 NWNXPushString(sCDKeyOrCommunityName);
742 NWNXCall(NWNX_Player,
"SetPersistentLocation");
747 NWNXPushObject(
oItem);
748 NWNXPushObject(oPlayer);
749 NWNXCall(NWNX_Player,
"UpdateItemName");
754 NWNXPushInt(bCreateDefaultQB);
755 NWNXPushInt(bMindImmune);
756 NWNXPushObject(oPossessed);
757 NWNXPushObject(oPossessor);
758 NWNXCall(NWNX_Player,
"PossessCreature");
764 NWNXPushObject(oPlayer);
765 NWNXCall(NWNX_Player,
"GetPlatformId");
771 NWNXPushObject(oPlayer);
772 NWNXCall(NWNX_Player,
"GetLanguage");
778 NWNXPushString(sNewResName);
779 NWNXPushString(sOldResName);
780 NWNXPushInt(nResType);
781 NWNXPushObject(oPlayer);
782 NWNXCall(NWNX_Player,
"SetResManOverride");
787 NWNXPushString(sTokenValue);
788 NWNXPushInt(nCustomTokenNumber);
789 NWNXPushObject(oPlayer);
790 NWNXCall(NWNX_Player,
"SetCustomToken");
795 NWNXPushString(sName);
796 NWNXPushObject(oCreature);
797 NWNXPushObject(oPlayer);
798 NWNXCall(NWNX_Player,
"SetCreatureNameOverride");
803 NWNXPushInt(bChatWindow);
804 NWNXPushString(sText);
805 NWNXPushObject(oCreature);
806 NWNXPushObject(oPlayer);
807 NWNXCall(NWNX_Player,
"FloatingTextStringOnCreature");
813 NWNXPushObject(oPlayer);
814 NWNXCall(NWNX_Player,
"ToggleDM");
819 NWNXPushInt(nCursor);
820 NWNXPushObject(oObject);
821 NWNXPushObject(oPlayer);
822 NWNXCall(NWNX_Player,
"SetObjectMouseCursorOverride");
828 NWNXPushObject(oObject);
829 NWNXPushObject(oPlayer);
830 NWNXCall(NWNX_Player,
"SetObjectHiliteColorOverride");
835 NWNXPushString(sEffectTag);
836 NWNXPushObject(oPlayer);
837 NWNXCall(NWNX_Player,
"RemoveEffectFromTURD");
842 NWNXPushLocation(locSpawn);
843 NWNXPushObject(oPlayer);
844 NWNXCall(NWNX_Player,
"SetSpawnLocation");
849 NWNXPushObject(oPlayer);
850 NWNXCall(NWNX_Player,
"SendDMAllCreatorLists");
855 NWNXPushInt(nSilentUpdate);
862 NWNXPushInt(journalEntry.
nState);
863 NWNXPushString(journalEntry.
sTag);
864 NWNXPushString(journalEntry.
sText);
865 NWNXPushString(journalEntry.
sName);
866 NWNXPushObject(oPlayer);
867 NWNXCall(NWNX_Player,
"AddCustomJournalEntry");
874 NWNXPushString(questTag);
875 NWNXPushObject(oPlayer);
876 NWNXCall(NWNX_Player,
"GetJournalEntry");
877 entry.nUpdated = NWNXPopInt();
878 if(entry.nUpdated == -1)
882 entry.nQuestDisplayed = NWNXPopInt();
883 entry.nQuestCompleted = NWNXPopInt();
884 entry.nPriority = NWNXPopInt();
885 entry.nState = NWNXPopInt();
886 entry.nTimeOfDay = NWNXPopInt();
887 entry.nCalendarDay = NWNXPopInt();
888 entry.sName = NWNXPopString();
889 entry.sText = NWNXPopString();
890 entry.sTag = questTag;
896 NWNXPushObject(oPlayer);
897 NWNXCall(NWNX_Player,
"CloseStore");
902 NWNXPushInt(bRestoreGlobal);
903 NWNXPushString(sOverride);
904 NWNXPushInt(nStrRef);
905 NWNXPushObject(oPlayer);
906 NWNXCall(NWNX_Player,
"SetTlkOverride");
911 NWNXPushObject(oPlayer);
912 NWNXCall(NWNX_Player,
"ReloadTlk");
917 NWNXPushFloat(fPitch);
919 NWNXPushFloat(fMagnitude);
920 NWNXPushVector(vDirection);
921 NWNXPushObject(oPlayer);
922 NWNXCall(NWNX_Player,
"UpdateWind");
927 NWNXPushInt(nSkyBox);
928 NWNXPushObject(oPlayer);
929 NWNXCall(NWNX_Player,
"UpdateSkyBox");
934 NWNXPushInt(nMoonFogColor);
935 NWNXPushInt(nSunFogColor);
936 NWNXPushObject(oPlayer);
937 NWNXCall(NWNX_Player,
"UpdateFogColor");
942 NWNXPushInt(nMoonFogAmount);
943 NWNXPushInt(nSunFogAmount);
944 NWNXPushObject(oPlayer);
945 NWNXCall(NWNX_Player,
"UpdateFogAmount");
950 NWNXPushObject(oPlayer);
951 NWNXCall(NWNX_Player,
"GetGameObject");
952 return NWNXPopObject();
958 NWNXPushObject(oObject);
959 NWNXPushObject(oPlayer);
960 NWNXCall(NWNX_Player,
"SetObjectUiDiscoveryMaskOverride");
965 NWNXPushInt(bHideDialog);
966 NWNXPushInt(bForceInvite);
967 NWNXPushObject(oInviter);
968 NWNXPushObject(oPlayer);
969 NWNXCall(NWNX_Player,
"SendPartyInvite");
974 NWNXPushObject(oPlayer);
975 NWNXCall(NWNX_Player,
"GetTURD");
976 return NWNXPopObject();
981 NWNXPushObject(oPlayer);
982 NWNXCall(NWNX_Player,
"ReloadColorPalettes");
987 NWNXPushObject(oPlayer);
988 NWNXCall(NWNX_Player,
"GetOpenStore");
989 return NWNXPopObject();
void NWNX_Player_MusicBattleStart(object player)
Starts the battle music for the given player only.
void NWNX_Player_SetAlwaysWalk(object player, int bWalk=TRUE)
Sets whether the player should always walk when given movement commands.
void NWNX_Player_MusicBackgroundStart(object player)
Starts the background music for the given player only.
void NWNX_Player_SetRestAnimation(object oPlayer, int nAnimation)
Override player's rest animation.
void NWNX_Player_MusicBackgroundChangeNight(object player, int track)
Changes the nighttime music track for the given player only.
void NWNX_Player_SetRestDuration(object player, int duration)
Override player's rest duration.
const int NWNX_PLAYER_PLATFORM_LINUX_X86
void NWNX_Player_SetPlaceableNameOverride(object player, object placeable, string name)
Override the name of placeable for player only.
object NWNX_Player_GetTURD(object oPlayer)
Get the TURD for oPlayer.
const int NWNX_PLAYER_PLATFORM_NINTENDO_SWITCH
void NWNX_Player_FloatingTextStringOnCreature(object oPlayer, object oCreature, string sText, int bChatWindow=TRUE)
Display floaty text above oCreature for oPlayer only.
int NWNX_Player_GetLanguage(object oPlayer)
Returns the game language of the given player (uses NWNX_DIALOG_LANGUAGE_*)
const int NWNX_PLAYER_PLATFORM_MICROSOFT_XBOXONE
const int NWNX_PLAYER_TIMING_BAR_LOCK
const int NWNX_PLAYER_PLATFORM_WINDOWS_X64
void NWNX_Player_OpenInventory(object player, object target, int open=TRUE)
Allows player to open target's inventory.
void NWNX_Player_SetResManOverride(object oPlayer, int nResType, string sOldResName, string sNewResName)
Override sOldResName with sNewResName of nResType for oPlayer.
void NWNX_Player_UpdateSkyBox(object oPlayer, int nSkyBox)
Update the SkyBox for oPlayer only.
void NWNX_Player_MusicBattleChange(object player, int track)
Changes the battle music track for the given player only.
const int NWNX_PLAYER_PLATFORM_ANDROID_ARM32
const int NWNX_PLAYER_PLATFORM_LINUX_ARM64
void NWNX_Player_SetObjectHiliteColorOverride(object oPlayer, object oObject, int nColor)
Override the hilite color of oObject for oPlayer only.
const int NWNX_PLAYER_TIMING_BAR_TRAP_SET
int NWNX_Player_GetQuestCompleted(object player, string sQuestName)
Gets whether a quest has been completed by a player.
void NWNX_Player_RemoveEffectFromTURD(object oPlayer, string sEffectTag)
Remove effects with sEffectTag from oPlayer's TURD.
const int NWNX_PLAYER_PLATFORM_MAC_X64
void NWNX_Player_ForcePlaceableInventoryWindow(object player, object placeable)
Force opens the target object's inventory for the player.
const int NWNX_PLAYER_TIMING_BAR_TRAP_RECOVER
void NWNX_Player_MusicBattleStop(object player)
Stops the battle music for the given player only.
const int NWNX_PLAYER_PLATFORM_ANDROID_X64
object NWNX_Player_GetOpenStore(object oPlayer)
Get the current open store of oPlayer.
void NWNX_Player_SetObjectMouseCursorOverride(object oPlayer, object oObject, int nCursor)
Override the mouse cursor of oObject for oPlayer only.
void NWNX_Player_SetPersistentLocation(string sCDKeyOrCommunityName, string sBicFileName, object oWP, int bFirstConnectOnly=TRUE)
Place waypoints on module load representing where a PC should start.
const int NWNX_PLAYER_PLATFORM_WINDOWS_X86
void NWNX_Player_SendDMAllCreatorLists(object oPlayer)
Resends palettes to a DM.
const int NWNX_PLAYER_TIMING_BAR_TRAP_FLAG
void NWNX_Player_MusicBackgroundStop(object player)
Stops the background music for the given player only.
void NWNX_Player_SetPlaceableUsable(object player, object placeable, int usable)
Toggle a placeable's usable flag for the given player only.
void NWNX_Player_ApplyLoopingVisualEffectToObject(object player, object target, int visualeffect)
Apply a looping visualeffect to a target that only player can see.
struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry(object oPlayer, string questTag)
Returns a struct containing a journal entry that can then be modified.
const int NWNX_PLAYER_TIMING_BAR_TRAP_DISARM
const int NWNX_PLAYER_PLATFORM_INVALID
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.
int NWNX_Player_GetPlatformId(object oPlayer)
Returns the platform ID of the given player (NWNX_PLAYER_PLATFORM_*)
int NWNX_Player_AddCustomJournalEntry(object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate=0)
Give a custom journal entry to oPlayer.
struct NWNX_Player_QuickBarSlot NWNX_Player_GetQuickBarSlot(object player, int slot)
Gets the player's quickbar slot info.
const int NWNX_PLAYER_PLATFORM_IOS
void NWNX_Player_CloseStore(object oPlayer)
Closes any store oPlayer may have open.
void NWNX_Player_UpdateFogAmount(object oPlayer, int nSunFogAmount, int nMoonFogAmount)
Update Sun and Moon Fog Amount for oPlayer only.
void NWNX_Player_ForcePlaceableExamineWindow(object player, object placeable)
Force display placeable examine window for player.
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.
void NWNX_Player_SetSpawnLocation(object oPlayer, location locSpawn)
Set the location oPlayer will spawn when logging in to the server.
const int NWNX_PLAYER_TIMING_BAR_TRAP_EXAMINE
void NWNX_Player_SetCreatureNameOverride(object oPlayer, object oCreature, string sName)
Override the name of creature for player only.
void NWNX_Player_UpdateFogColor(object oPlayer, int nSunFogColor, int nMoonFogColor)
Update Sun and Moon Fog Color for oPlayer only.
void NWNX_Player_ToggleDM(object oPlayer, int bIsDM)
Toggle oPlayer's PlayerDM status.
string NWNX_Player_GetBicFileName(object player)
Get the name of the .bic file associated with the player's character.
const int NWNX_PLAYER_PLATFORM_LINUX_X64
void NWNX_Player_StopGuiTimingBar(object player, string script="")
Stop displaying a timing bar.
void NWNX_Player_SetAreaExplorationState(object player, object area, string str)
Set player's area exploration state.
void NWNX_Player_SetObjectUiDiscoveryMaskOverride(object oPlayer, object oObject, int nMask)
Override the ui discovery mask of oObject for oPlayer only.
const int NWNX_PLAYER_PLATFORM_ANDROID_ARM64
const int NWNX_PLAYER_TIMING_BAR_REST
void NWNX_Player_ReloadColorPalettes(object oPlayer)
Reloads the color palettes for oPlayer.
void NWNX_Player_SetTlkOverride(object oPlayer, int nStrRef, string sOverride, int bRestoreGlobal=TRUE)
Override nStrRef from the TlkTable with sOverride for oPlayer only.
void NWNX_Player_UpdateWind(object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch)
Update wind for oPlayer only.
void NWNX_Player_SetQuickBarSlot(object player, int slot, struct NWNX_Player_QuickBarSlot qbs)
Sets the player's quickbar slot info.
void NWNX_Player_StartGuiTimingBar(object player, float seconds, string script="", int type=NWNX_PLAYER_TIMING_BAR_CUSTOM)
Starts displaying a timing bar.
void NWNX_Player_MusicBackgroundChangeDay(object player, int track)
Changes the daytime music track for the given player only.
void NWNX_Player_SetCustomToken(object oPlayer, int nCustomTokenNumber, string sTokenValue)
Set nCustomTokenNumber to sTokenValue for oPlayer only.
void NWNX_Player_UpdateItemName(object oPlayer, object oItem)
Force an item name to be updated.
void NWNX_Player_ReloadTlk(object oPlayer)
Make the player reload it's TlkTable.
const int NWNX_PLAYER_PLATFORM_LINUX_ARM32
int NWNX_Player_PossessCreature(object oPossessor, object oPossessed, int bMindImmune=TRUE, int bCreateDefaultQB=FALSE)
Possesses a creature by temporarily making them a familiar.
string NWNX_Player_GetAreaExplorationState(object player, object area)
Get player's area exploration state.
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.
const int NWNX_PLAYER_PLATFORM_SONY_PS4
object NWNX_Player_GetGameObject(object oPlayer)
Return's the currently-possessed game object of a player.
void NWNX_Player_SendPartyInvite(object oPlayer, object oInviter, int bForceInvite=FALSE, int bHideDialog=FALSE)
Send a party invite from oInviter to oPlayer.
const int NWNX_PLAYER_PLATFORM_MAC_X86
void NWNX_Player_UpdateCharacterSheet(object player)
Refreshes the players character sheet.
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.
const int NWNX_PLAYER_TIMING_BAR_CUSTOM
const int NWNX_PLAYER_TIMING_BAR_UNLOCK