NWNX:EE  8193.37.14
nwnx_player.nss
Go to the documentation of this file.
1 
6 const string NWNX_Player = "NWNX_Player";
7 
10 {
11  object oItem;
12  object oSecondaryItem;
15  string sResRef;
16  string sCommandLabel;
17  string sCommandLine;
18  string sToolTip;
19  int nINTParam1;
20  int nMetaType;
23  object oAssociate;
24 };
25 
28 {
29  string sName;
30  string sText;
31  string sTag;
32  int nState;
33  int nPriority;
36  int nUpdated;
39 };
40 
41 
57 
70 const int NWNX_PLAYER_PLATFORM_IOS = 30;
78 
83 void NWNX_Player_ForcePlaceableExamineWindow(object player, object placeable);
84 
95 void NWNX_Player_ForcePlaceableInventoryWindow(object player, object placeable);
96 
103 void NWNX_Player_StartGuiTimingBar(object player, float seconds, string script = "", int type = NWNX_PLAYER_TIMING_BAR_CUSTOM);
104 
108 void NWNX_Player_StopGuiTimingBar(object player, string script = "");
109 
114 void NWNX_Player_SetAlwaysWalk(object player, int bWalk=TRUE);
115 
120 struct NWNX_Player_QuickBarSlot NWNX_Player_GetQuickBarSlot(object player, int slot);
121 
126 void NWNX_Player_SetQuickBarSlot(object player, int slot, struct NWNX_Player_QuickBarSlot qbs);
127 
131 string NWNX_Player_GetBicFileName(object player);
132 
140 void NWNX_Player_ShowVisualEffect(object player, int effectId, vector position, float scale=1.0f, vector translate=[], vector rotate=[]);
141 
145 void NWNX_Player_MusicBackgroundChangeDay(object player, int track);
146 
150 void NWNX_Player_MusicBackgroundChangeNight(object player, int track);
151 
154 void NWNX_Player_MusicBackgroundStart(object player);
155 
158 void NWNX_Player_MusicBackgroundStop(object player);
159 
163 void NWNX_Player_MusicBattleChange(object player, int track);
164 
167 void NWNX_Player_MusicBattleStart(object player);
168 
171 void NWNX_Player_MusicBattleStop(object player);
172 
178 void NWNX_Player_PlaySound(object player, string sound, object target = OBJECT_INVALID);
179 
184 void NWNX_Player_SetPlaceableUsable(object player, object placeable, int usable);
185 
189 void NWNX_Player_SetRestDuration(object player, int duration);
190 
199 void NWNX_Player_ApplyInstantVisualEffectToObject(object player, object target, int visualeffect, float scale=1.0f, vector translate=[], vector rotate=[]);
200 
205 void NWNX_Player_UpdateCharacterSheet(object player);
206 
212 void NWNX_Player_OpenInventory(object player, object target, int open = TRUE);
213 
218 string NWNX_Player_GetAreaExplorationState(object player, object area);
219 
224 void NWNX_Player_SetAreaExplorationState(object player, object area, string str);
225 
231 void NWNX_Player_SetRestAnimation(object oPlayer, int nAnimation);
232 
238 void NWNX_Player_SetObjectVisualTransformOverride(object oPlayer, object oObject, int nTransform, float fValue);
239 
246 void NWNX_Player_ApplyLoopingVisualEffectToObject(object player, object target, int visualeffect);
247 
252 void NWNX_Player_SetPlaceableNameOverride(object player, object placeable, string name);
253 
258 int NWNX_Player_GetQuestCompleted(object player, string sQuestName);
259 
271 void NWNX_Player_SetPersistentLocation(string sCDKeyOrCommunityName, string sBicFileName, object oWP, int bFirstConnectOnly = TRUE);
272 
277 void NWNX_Player_UpdateItemName(object oPlayer, object oItem);
278 
293 int NWNX_Player_PossessCreature(object oPossessor, object oPossessed, int bMindImmune = TRUE, int bCreateDefaultQB = FALSE);
294 
297 int NWNX_Player_GetPlatformId(object oPlayer);
298 
303 int NWNX_Player_GetLanguage(object oPlayer);
304 
311 void NWNX_Player_SetResManOverride(object oPlayer, int nResType, string sOldResName, string sNewResName);
312 
318 void NWNX_Player_SetCustomToken(object oPlayer, int nCustomTokenNumber, string sTokenValue);
319 
324 void NWNX_Player_SetCreatureNameOverride(object oPlayer, object oCreature, string sName);
325 
332 void NWNX_Player_FloatingTextStringOnCreature(object oPlayer, object oCreature, string sText, int bChatWindow = TRUE);
333 
338 void NWNX_Player_ToggleDM(object oPlayer, int bIsDM);
339 
344 void NWNX_Player_SetObjectMouseCursorOverride(object oPlayer, object oObject, int nCursor);
345 
350 void NWNX_Player_SetObjectHiliteColorOverride(object oPlayer, object oObject, int nColor);
351 
356 void NWNX_Player_RemoveEffectFromTURD(object oPlayer, string sEffectTag);
357 
362 void NWNX_Player_SetSpawnLocation(object oPlayer, location locSpawn);
363 
366 void NWNX_Player_SendDMAllCreatorLists(object oPlayer);
367 
376 int NWNX_Player_AddCustomJournalEntry(object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate = 0);
377 
385 struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry(object oPlayer, string questTag);
386 
389 void NWNX_Player_CloseStore(object oPlayer);
390 
397 void NWNX_Player_SetTlkOverride(object oPlayer, int nStrRef, string sOverride, int bRestoreGlobal = TRUE);
398 
401 void NWNX_Player_ReloadTlk(object oPlayer);
402 
409 void NWNX_Player_UpdateWind(object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch);
410 
414 void NWNX_Player_UpdateSkyBox(object oPlayer, int nSkyBox);
415 
420 void NWNX_Player_UpdateFogColor(object oPlayer, int nSunFogColor, int nMoonFogColor);
421 
422 
427 void NWNX_Player_UpdateFogAmount(object oPlayer, int nSunFogAmount, int nMoonFogAmount);
428 
432 object NWNX_Player_GetGameObject(object oPlayer);
433 
438 void NWNX_Player_SetObjectUiDiscoveryMaskOverride(object oPlayer, object oObject, int nMask);
439 
445 void NWNX_Player_SendPartyInvite(object oPlayer, object oInviter, int bForceInvite = FALSE, int bHideDialog = FALSE);
446 
450 object NWNX_Player_GetTURD(object oPlayer);
451 
454 void NWNX_Player_ReloadColorPalettes(object oPlayer);
455 
459 object NWNX_Player_GetOpenStore(object oPlayer);
460 
462 
463 void NWNX_Player_ForcePlaceableExamineWindow(object player, object placeable)
464 {
465  NWNXPushObject(placeable);
466  NWNXPushObject(player);
467  NWNXCall(NWNX_Player, "ForcePlaceableExamineWindow");
468 }
469 
470 void NWNX_Player_ForcePlaceableInventoryWindow(object player, object placeable)
471 {
472  NWNXPushObject(placeable);
473  NWNXPushObject(player);
474  NWNXCall(NWNX_Player, "ForcePlaceableInventoryWindow");
475 }
476 
477 void NWNX_Player_INTERNAL_StopGuiTimingBar(object player, string script = "", int id = -1)
478 {
479  int activeId = GetLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ACTIVE");
480  // Either the timing event was never started, or it already finished.
481  if (activeId == 0)
482  return;
483  // If id != -1, we ended up here through DelayCommand. Make sure it's for the right ID
484  if (id != -1 && id != activeId)
485  return;
486  DeleteLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ACTIVE");
487  NWNXPushObject(player);
488  NWNXCall(NWNX_Player, "StopGuiTimingBar");
489  if(script != "")
490  {
491  ExecuteScript(script, player);
492  }
493 }
494 
495 void NWNX_Player_StartGuiTimingBar(object player, float seconds, string script = "", int type = NWNX_PLAYER_TIMING_BAR_CUSTOM)
496 {
497  if (GetLocalInt(player, "NWNX_PLAYER_GUI_TIMING_ACTIVE"))
498  return;
499  NWNXPushInt(type);
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));
507 }
508 
509 void NWNX_Player_StopGuiTimingBar(object player, string script = "")
510 {
511  NWNX_Player_INTERNAL_StopGuiTimingBar(player, script, -1);
512 }
513 
514 void NWNX_Player_SetAlwaysWalk(object player, int bWalk=TRUE)
515 {
516  NWNXPushInt(bWalk);
517  NWNXPushObject(player);
518  NWNXCall(NWNX_Player, "SetAlwaysWalk");
519 }
520 
521 struct NWNX_Player_QuickBarSlot NWNX_Player_GetQuickBarSlot(object player, int slot)
522 {
523  struct NWNX_Player_QuickBarSlot qbs;
524  NWNXPushInt(slot);
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();
540  return qbs;
541 }
542 
543 void NWNX_Player_SetQuickBarSlot(object player, int slot, struct NWNX_Player_QuickBarSlot qbs)
544 {
545  NWNXPushObject(qbs.oItem);
546  NWNXPushObject(qbs.oSecondaryItem);
547  NWNXPushInt(qbs.nObjectType);
548  NWNXPushInt(qbs.nMultiClass);
549  NWNXPushString(qbs.sResRef);
550  NWNXPushString(qbs.sCommandLabel);
551  NWNXPushString(qbs.sCommandLine);
552  NWNXPushString(qbs.sToolTip);
553  NWNXPushInt(qbs.nINTParam1);
554  NWNXPushInt(qbs.nMetaType);
555  NWNXPushInt(qbs.nDomainLevel);
556  NWNXPushInt(qbs.nAssociateType);
557  NWNXPushObject(qbs.oAssociate);
558  NWNXPushInt(slot);
559  NWNXPushObject(player);
560  NWNXCall(NWNX_Player, "SetQuickBarSlot");
561 }
562 
563 string NWNX_Player_GetBicFileName(object player)
564 {
565  NWNXPushObject(player);
566  NWNXCall(NWNX_Player, "GetBicFileName");
567  return NWNXPopString();
568 }
569 
570 void NWNX_Player_ShowVisualEffect(object player, int effectId, vector position, float scale=1.0f, vector translate=[], vector rotate=[])
571 {
572  NWNXPushVector(rotate);
573  NWNXPushVector(translate);
574  NWNXPushFloat(scale);
575  NWNXPushVector(position);
576  NWNXPushInt(effectId);
577  NWNXPushObject(player);
578  NWNXCall(NWNX_Player, "ShowVisualEffect");
579 }
580 
581 void NWNX_Player_MusicBackgroundChangeDay(object player, int track)
582 {
583  NWNXPushInt(track);
584  NWNXPushInt(TRUE);
585  NWNXPushObject(player);
586  NWNXCall(NWNX_Player, "ChangeBackgroundMusic");
587 }
588 
589 void NWNX_Player_MusicBackgroundChangeNight(object player, int track)
590 {
591  NWNXPushInt(track);
592  NWNXPushInt(FALSE);
593  NWNXPushObject(player);
594  NWNXCall(NWNX_Player, "ChangeBackgroundMusic");
595 }
596 
598 {
599  NWNXPushInt(TRUE);
600  NWNXPushObject(player);
601  NWNXCall(NWNX_Player, "PlayBackgroundMusic");
602 }
603 
605 {
606  NWNXPushInt(FALSE);
607  NWNXPushObject(player);
608  NWNXCall(NWNX_Player, "PlayBackgroundMusic");
609 }
610 
611 void NWNX_Player_MusicBattleChange(object player, int track)
612 {
613  NWNXPushInt(track);
614  NWNXPushObject(player);
615  NWNXCall(NWNX_Player, "ChangeBattleMusic");
616 }
617 
618 void NWNX_Player_MusicBattleStart(object player)
619 {
620  NWNXPushInt(TRUE);
621  NWNXPushObject(player);
622  NWNXCall(NWNX_Player, "PlayBattleMusic");
623 }
624 
625 void NWNX_Player_MusicBattleStop(object player)
626 {
627  NWNXPushInt(FALSE);
628  NWNXPushObject(player);
629  NWNXCall(NWNX_Player, "PlayBattleMusic");
630 }
631 
632 void NWNX_Player_PlaySound(object player, string sound, object target = OBJECT_INVALID)
633 {
634  NWNXPushObject(target);
635  NWNXPushString(sound);
636  NWNXPushObject(player);
637  NWNXCall(NWNX_Player, "PlaySound");
638 }
639 
640 void NWNX_Player_SetPlaceableUsable(object player, object placeable, int usable)
641 {
642  NWNXPushInt(usable);
643  NWNXPushObject(placeable);
644  NWNXPushObject(player);
645  NWNXCall(NWNX_Player, "SetPlaceableUsable");
646 }
647 
648 void NWNX_Player_SetRestDuration(object player, int duration)
649 {
650  NWNXPushInt(duration);
651  NWNXPushObject(player);
652  NWNXCall(NWNX_Player, "SetRestDuration");
653 }
654 
655 void NWNX_Player_ApplyInstantVisualEffectToObject(object player, object target, int visualeffect, float scale=1.0f, vector translate=[], vector rotate=[])
656 {
657  NWNXPushVector(rotate);
658  NWNXPushVector(translate);
659  NWNXPushFloat(scale);
660  NWNXPushInt(visualeffect);
661  NWNXPushObject(target);
662  NWNXPushObject(player);
663  NWNXCall(NWNX_Player, "ApplyInstantVisualEffectToObject");
664 }
665 
667 {
668  NWNXPushObject(player);
669  NWNXCall(NWNX_Player, "UpdateCharacterSheet");
670 }
671 
672 void NWNX_Player_OpenInventory(object player, object target, int open = TRUE)
673 {
674  NWNXPushInt(open);
675  NWNXPushObject(target);
676  NWNXPushObject(player);
677  NWNXCall(NWNX_Player, "OpenInventory");
678 }
679 
680 string NWNX_Player_GetAreaExplorationState(object player, object area)
681 {
682  NWNXPushObject(area);
683  NWNXPushObject(player);
684  NWNXCall(NWNX_Player, "GetAreaExplorationState");
685  return NWNXPopString();
686 }
687 
688 void NWNX_Player_SetAreaExplorationState(object player, object area, string str)
689 {
690  NWNXPushString(str);
691  NWNXPushObject(area);
692  NWNXPushObject(player);
693  NWNXCall(NWNX_Player, "SetAreaExplorationState");
694 }
695 
696 void NWNX_Player_SetRestAnimation(object oPlayer, int nAnimation)
697 {
698  NWNXPushInt(nAnimation);
699  NWNXPushObject(oPlayer);
700  NWNXCall(NWNX_Player, "SetRestAnimation");
701 }
702 
703 void NWNX_Player_SetObjectVisualTransformOverride(object oPlayer, object oObject, int nTransform, float fValue)
704 {
705  NWNXPushFloat(fValue);
706  NWNXPushInt(nTransform);
707  NWNXPushObject(oObject);
708  NWNXPushObject(oPlayer);
709  NWNXCall(NWNX_Player, "SetObjectVisualTransformOverride");
710 }
711 
712 void NWNX_Player_ApplyLoopingVisualEffectToObject(object player, object target, int visualeffect)
713 {
714  NWNXPushInt(visualeffect);
715  NWNXPushObject(target);
716  NWNXPushObject(player);
717  NWNXCall(NWNX_Player, "ApplyLoopingVisualEffectToObject");
718 }
719 
720 void NWNX_Player_SetPlaceableNameOverride(object player, object placeable, string name)
721 {
722  NWNXPushString(name);
723  NWNXPushObject(placeable);
724  NWNXPushObject(player);
725  NWNXCall(NWNX_Player, "SetPlaceableNameOverride");
726 }
727 
728 int NWNX_Player_GetQuestCompleted(object player, string sQuestName)
729 {
730  NWNXPushString(sQuestName);
731  NWNXPushObject(player);
732  NWNXCall(NWNX_Player, "GetQuestCompleted");
733  return NWNXPopInt();
734 }
735 
736 void NWNX_Player_SetPersistentLocation(string sCDKeyOrCommunityName, string sBicFileName, object oWP, int bFirstConnectOnly = TRUE)
737 {
738  NWNXPushInt(bFirstConnectOnly);
739  NWNXPushObject(oWP);
740  NWNXPushString(sBicFileName);
741  NWNXPushString(sCDKeyOrCommunityName);
742  NWNXCall(NWNX_Player, "SetPersistentLocation");
743 }
744 
745 void NWNX_Player_UpdateItemName(object oPlayer, object oItem)
746 {
747  NWNXPushObject(oItem);
748  NWNXPushObject(oPlayer);
749  NWNXCall(NWNX_Player, "UpdateItemName");
750 }
751 
752 int NWNX_Player_PossessCreature(object oPossessor, object oPossessed, int bMindImmune = TRUE, int bCreateDefaultQB = FALSE)
753 {
754  NWNXPushInt(bCreateDefaultQB);
755  NWNXPushInt(bMindImmune);
756  NWNXPushObject(oPossessed);
757  NWNXPushObject(oPossessor);
758  NWNXCall(NWNX_Player, "PossessCreature");
759  return NWNXPopInt();
760 }
761 
762 int NWNX_Player_GetPlatformId(object oPlayer)
763 {
764  NWNXPushObject(oPlayer);
765  NWNXCall(NWNX_Player, "GetPlatformId");
766  return NWNXPopInt();
767 }
768 
769 int NWNX_Player_GetLanguage(object oPlayer)
770 {
771  NWNXPushObject(oPlayer);
772  NWNXCall(NWNX_Player, "GetLanguage");
773  return NWNXPopInt();
774 }
775 
776 void NWNX_Player_SetResManOverride(object oPlayer, int nResType, string sOldResName, string sNewResName)
777 {
778  NWNXPushString(sNewResName);
779  NWNXPushString(sOldResName);
780  NWNXPushInt(nResType);
781  NWNXPushObject(oPlayer);
782  NWNXCall(NWNX_Player, "SetResManOverride");
783 }
784 
785 void NWNX_Player_SetCustomToken(object oPlayer, int nCustomTokenNumber, string sTokenValue)
786 {
787  NWNXPushString(sTokenValue);
788  NWNXPushInt(nCustomTokenNumber);
789  NWNXPushObject(oPlayer);
790  NWNXCall(NWNX_Player, "SetCustomToken");
791 }
792 
793 void NWNX_Player_SetCreatureNameOverride(object oPlayer, object oCreature, string sName)
794 {
795  NWNXPushString(sName);
796  NWNXPushObject(oCreature);
797  NWNXPushObject(oPlayer);
798  NWNXCall(NWNX_Player, "SetCreatureNameOverride");
799 }
800 
801 void NWNX_Player_FloatingTextStringOnCreature(object oPlayer, object oCreature, string sText, int bChatWindow = TRUE)
802 {
803  NWNXPushInt(bChatWindow);
804  NWNXPushString(sText);
805  NWNXPushObject(oCreature);
806  NWNXPushObject(oPlayer);
807  NWNXCall(NWNX_Player, "FloatingTextStringOnCreature");
808 }
809 
810 void NWNX_Player_ToggleDM(object oPlayer, int bIsDM)
811 {
812  NWNXPushInt(bIsDM);
813  NWNXPushObject(oPlayer);
814  NWNXCall(NWNX_Player, "ToggleDM");
815 }
816 
817 void NWNX_Player_SetObjectMouseCursorOverride(object oPlayer, object oObject, int nCursor)
818 {
819  NWNXPushInt(nCursor);
820  NWNXPushObject(oObject);
821  NWNXPushObject(oPlayer);
822  NWNXCall(NWNX_Player, "SetObjectMouseCursorOverride");
823 }
824 
825 void NWNX_Player_SetObjectHiliteColorOverride(object oPlayer, object oObject, int nColor)
826 {
827  NWNXPushInt(nColor);
828  NWNXPushObject(oObject);
829  NWNXPushObject(oPlayer);
830  NWNXCall(NWNX_Player, "SetObjectHiliteColorOverride");
831 }
832 
833 void NWNX_Player_RemoveEffectFromTURD(object oPlayer, string sEffectTag)
834 {
835  NWNXPushString(sEffectTag);
836  NWNXPushObject(oPlayer);
837  NWNXCall(NWNX_Player, "RemoveEffectFromTURD");
838 }
839 
840 void NWNX_Player_SetSpawnLocation(object oPlayer, location locSpawn)
841 {
842  NWNXPushLocation(locSpawn);
843  NWNXPushObject(oPlayer);
844  NWNXCall(NWNX_Player, "SetSpawnLocation");
845 }
846 
848 {
849  NWNXPushObject(oPlayer);
850  NWNXCall(NWNX_Player, "SendDMAllCreatorLists");
851 }
852 
853 int NWNX_Player_AddCustomJournalEntry(object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate = 0)
854 {
855  NWNXPushInt(nSilentUpdate);
856  NWNXPushInt(journalEntry.nTimeOfDay);
857  NWNXPushInt(journalEntry.nCalendarDay);
858  NWNXPushInt(journalEntry.nUpdated);
859  NWNXPushInt(journalEntry.nQuestDisplayed);
860  NWNXPushInt(journalEntry.nQuestCompleted);
861  NWNXPushInt(journalEntry.nPriority);
862  NWNXPushInt(journalEntry.nState);
863  NWNXPushString(journalEntry.sTag);
864  NWNXPushString(journalEntry.sText);
865  NWNXPushString(journalEntry.sName);
866  NWNXPushObject(oPlayer);
867  NWNXCall(NWNX_Player, "AddCustomJournalEntry");
868  return NWNXPopInt();
869 }
870 
871 struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry(object oPlayer, string questTag)
872 {
873  struct NWNX_Player_JournalEntry entry;
874  NWNXPushString(questTag);
875  NWNXPushObject(oPlayer);
876  NWNXCall(NWNX_Player, "GetJournalEntry");
877  entry.nUpdated = NWNXPopInt();
878  if(entry.nUpdated == -1) // -1 set as an indicator to say that the entry was not found
879  {
880  return entry;
881  }
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;
891  return entry;
892 }
893 
894 void NWNX_Player_CloseStore(object oPlayer)
895 {
896  NWNXPushObject(oPlayer);
897  NWNXCall(NWNX_Player, "CloseStore");
898 }
899 
900 void NWNX_Player_SetTlkOverride(object oPlayer, int nStrRef, string sOverride, int bRestoreGlobal = TRUE)
901 {
902  NWNXPushInt(bRestoreGlobal);
903  NWNXPushString(sOverride);
904  NWNXPushInt(nStrRef);
905  NWNXPushObject(oPlayer);
906  NWNXCall(NWNX_Player, "SetTlkOverride");
907 }
908 
909 void NWNX_Player_ReloadTlk(object oPlayer)
910 {
911  NWNXPushObject(oPlayer);
912  NWNXCall(NWNX_Player, "ReloadTlk");
913 }
914 
915 void NWNX_Player_UpdateWind(object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch)
916 {
917  NWNXPushFloat(fPitch);
918  NWNXPushFloat(fYaw);
919  NWNXPushFloat(fMagnitude);
920  NWNXPushVector(vDirection);
921  NWNXPushObject(oPlayer);
922  NWNXCall(NWNX_Player, "UpdateWind");
923 }
924 
925 void NWNX_Player_UpdateSkyBox(object oPlayer, int nSkyBox)
926 {
927  NWNXPushInt(nSkyBox);
928  NWNXPushObject(oPlayer);
929  NWNXCall(NWNX_Player, "UpdateSkyBox");
930 }
931 
932 void NWNX_Player_UpdateFogColor(object oPlayer, int nSunFogColor, int nMoonFogColor)
933 {
934  NWNXPushInt(nMoonFogColor);
935  NWNXPushInt(nSunFogColor);
936  NWNXPushObject(oPlayer);
937  NWNXCall(NWNX_Player, "UpdateFogColor");
938 }
939 
940 void NWNX_Player_UpdateFogAmount(object oPlayer, int nSunFogAmount, int nMoonFogAmount)
941 {
942  NWNXPushInt(nMoonFogAmount);
943  NWNXPushInt(nSunFogAmount);
944  NWNXPushObject(oPlayer);
945  NWNXCall(NWNX_Player, "UpdateFogAmount");
946 }
947 
948 object NWNX_Player_GetGameObject(object oPlayer)
949 {
950  NWNXPushObject(oPlayer);
951  NWNXCall(NWNX_Player, "GetGameObject");
952  return NWNXPopObject();
953 }
954 
955 void NWNX_Player_SetObjectUiDiscoveryMaskOverride(object oPlayer, object oObject, int nMask)
956 {
957  NWNXPushInt(nMask);
958  NWNXPushObject(oObject);
959  NWNXPushObject(oPlayer);
960  NWNXCall(NWNX_Player, "SetObjectUiDiscoveryMaskOverride");
961 }
962 
963 void NWNX_Player_SendPartyInvite(object oPlayer, object oInviter, int bForceInvite = FALSE, int bHideDialog = FALSE)
964 {
965  NWNXPushInt(bHideDialog);
966  NWNXPushInt(bForceInvite);
967  NWNXPushObject(oInviter);
968  NWNXPushObject(oPlayer);
969  NWNXCall(NWNX_Player, "SendPartyInvite");
970 }
971 
972 object NWNX_Player_GetTURD(object oPlayer)
973 {
974  NWNXPushObject(oPlayer);
975  NWNXCall(NWNX_Player, "GetTURD");
976  return NWNXPopObject();
977 }
978 
980 {
981  NWNXPushObject(oPlayer);
982  NWNXCall(NWNX_Player, "ReloadColorPalettes");
983 }
984 
985 object NWNX_Player_GetOpenStore(object oPlayer)
986 {
987  NWNXPushObject(oPlayer);
988  NWNXCall(NWNX_Player, "GetOpenStore");
989  return NWNXPopObject();
990 }
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
Definition: nwnx_player.nss:64
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
Definition: nwnx_player.nss:74
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
Definition: nwnx_player.nss:75
const int NWNX_PLAYER_TIMING_BAR_LOCK
Definition: nwnx_player.nss:54
const int NWNX_PLAYER_PLATFORM_WINDOWS_X64
Definition: nwnx_player.nss:63
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
Definition: nwnx_player.nss:71
const int NWNX_PLAYER_PLATFORM_LINUX_ARM64
Definition: nwnx_player.nss:67
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
Definition: nwnx_player.nss:51
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
Definition: nwnx_player.nss:69
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
Definition: nwnx_player.nss:48
void NWNX_Player_MusicBattleStop(object player)
Stops the battle music for the given player only.
const int NWNX_PLAYER_PLATFORM_ANDROID_X64
Definition: nwnx_player.nss:73
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
Definition: nwnx_player.nss:62
void NWNX_Player_SendDMAllCreatorLists(object oPlayer)
Resends palettes to a DM.
const int NWNX_PLAYER_TIMING_BAR_TRAP_FLAG
Definition: nwnx_player.nss:47
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
Definition: nwnx_player.nss:49
const int NWNX_PLAYER_PLATFORM_INVALID
Definition: nwnx_player.nss:61
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
Definition: nwnx_player.nss:70
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
Definition: nwnx_player.nss:50
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
Definition: nwnx_player.nss:65
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
Definition: nwnx_player.nss:72
const int NWNX_PLAYER_TIMING_BAR_REST
Definition: nwnx_player.nss:52
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
Definition: nwnx_player.nss:66
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
Definition: nwnx_player.nss:76
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
Definition: nwnx_player.nss:68
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
Definition: nwnx_player.nss:55
const int NWNX_PLAYER_TIMING_BAR_UNLOCK
Definition: nwnx_player.nss:53
A journal entry.
Definition: nwnx_player.nss:28
A quickbar slot.
Definition: nwnx_player.nss:10