|
NWNX:EE
8193.36.12
|
|
Go to the documentation of this file.
7 const string NWNX_Player =
"NWNX_Player";
141 void NWNX_Player_ShowVisualEffect(
object player,
int effectId, vector position,
float scale=1.0f, vector translate=[], vector rotate=[]);
410 void NWNX_Player_UpdateWind(
object oPlayer, vector vDirection,
float fMagnitude,
float fYaw,
float fPitch);
461 string sFunc =
"ForcePlaceableExamineWindow";
471 string sFunc =
"ForcePlaceableInventoryWindow";
479 void NWNX_Player_INTERNAL_StopGuiTimingBar(
object player,
string script =
"",
int id = -1)
481 int activeId = GetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE");
487 if (
id != -1 &&
id != activeId)
490 DeleteLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE");
492 string sFunc =
"StopGuiTimingBar";
498 ExecuteScript(script, player);
504 if (GetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE"))
507 string sFunc =
"StartGuiTimingBar";
514 int id = GetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ID") + 1;
515 SetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ACTIVE",
id);
516 SetLocalInt(player,
"NWNX_PLAYER_GUI_TIMING_ID",
id);
518 DelayCommand(seconds, NWNX_Player_INTERNAL_StopGuiTimingBar(player, script,
id));
523 NWNX_Player_INTERNAL_StopGuiTimingBar(player, script, -1);
528 string sFunc =
"SetAlwaysWalk";
538 string sFunc =
"GetQuickBarSlot";
564 string sFunc =
"SetQuickBarSlot";
587 string sFunc =
"GetBicFileName";
596 string sFunc =
"ShowVisualEffect";
616 string sFunc =
"ChangeBackgroundMusic";
627 string sFunc =
"ChangeBackgroundMusic";
638 string sFunc =
"PlayBackgroundMusic";
648 string sFunc =
"PlayBackgroundMusic";
658 string sFunc =
"ChangeBattleMusic";
668 string sFunc =
"PlayBattleMusic";
678 string sFunc =
"PlayBattleMusic";
688 string sFunc =
"PlaySound";
699 string sFunc =
"SetPlaceableUsable";
710 string sFunc =
"SetRestDuration";
720 string sFunc =
"ApplyInstantVisualEffectToObject";
738 string sFunc =
"UpdateCharacterSheet";
747 string sFunc =
"OpenInventory";
758 string sFunc =
"GetAreaExplorationState";
769 string sFunc =
"SetAreaExplorationState";
780 string sFunc =
"SetRestAnimation";
790 string sFunc =
"SetObjectVisualTransformOverride";
802 string sFunc =
"ApplyLoopingVisualEffectToObject";
813 string sFunc =
"SetPlaceableNameOverride";
824 string sFunc =
"GetQuestCompleted";
835 string sFunc =
"SetPersistentLocation";
847 string sFunc =
"UpdateItemName";
857 string sFunc =
"PossessCreature";
870 string sFunc =
"GetPlatformId";
880 string sFunc =
"GetLanguage";
890 string sFunc =
"SetResManOverride";
902 string sFunc =
"SetCustomToken";
913 string sFunc =
"SetCreatureNameOverride";
924 string sFunc =
"FloatingTextStringOnCreature";
936 string sFunc =
"ToggleDM";
946 string sFunc =
"SetObjectMouseCursorOverride";
957 string sFunc =
"SetObjectHiliteColorOverride";
968 string sFunc =
"RemoveEffectFromTURD";
978 string sFunc =
"SetSpawnLocation";
980 vector vPosition = GetPositionFromLocation(locSpawn);
994 string sFunc =
"SendDMAllCreatorLists";
1001 string sFunc =
"AddCustomJournalEntry";
1020 string sFunc =
"GetJournalEntry";
1040 entry.
sTag = questTag;
1046 string sFunc =
"CloseStore";
1054 string sFunc =
"SetTlkOverride";
1065 string sFunc =
"ReloadTlk";
1073 string sFunc =
"UpdateWind";
1087 string sFunc =
"UpdateSkyBox";
1096 string sFunc =
"UpdateFogColor";
1106 string sFunc =
"UpdateFogAmount";
1116 string sFunc =
"GetGameObject";
1125 string sFunc =
"SetObjectUiDiscoveryMaskOverride";
1136 string sFunc =
"SendPartyInvite";
1148 string sFunc =
"GetTURD";
1158 string sFunc =
"ReloadColorPalettes";
void NWNX_Player_SetAreaExplorationState(object player, object area, string str)
Set player's area exploration state.
int NWNX_GetReturnValueInt()
Returns the specified type from the c++ side.
void NWNX_Player_SendDMAllCreatorLists(object oPlayer)
Resends palettes to a DM.
void NWNX_Player_SetPlaceableNameOverride(object player, object placeable, string name)
Override the name of placeable for player only.
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_SetRestDuration(object player, int duration)
Override player's rest duration.
const int NWNX_PLAYER_PLATFORM_WINDOWS_X86
void NWNX_Player_OpenInventory(object player, object target, int open=TRUE)
Allows player to open target's inventory.
void NWNX_Player_SendPartyInvite(object oPlayer, object oInviter, int bForceInvite=FALSE, int bHideDialog=FALSE)
Send a party invite from oInviter to oPlayer.
void NWNX_Player_CloseStore(object oPlayer)
Closes any store oPlayer may have open.
void NWNX_Player_UpdateSkyBox(object oPlayer, int nSkyBox)
Update the SkyBox for oPlayer only.
const int NWNX_PLAYER_PLATFORM_LINUX_ARM64
void NWNX_Player_SetObjectUiDiscoveryMaskOverride(object oPlayer, object oObject, int nMask)
Override the ui discovery mask of oObject for oPlayer only.
void NWNX_Player_RemoveEffectFromTURD(object oPlayer, string sEffectTag)
Remove effects with sEffectTag from oPlayer's TURD.
void NWNX_Player_ApplyLoopingVisualEffectToObject(object player, object target, int visualeffect)
Apply a looping visualeffect to a target that only player can see.
void NWNX_Player_MusicBattleChange(object player, int track)
Changes the battle music track for the given player only.
const int NWNX_PLAYER_TIMING_BAR_TRAP_EXAMINE
void NWNX_Player_UpdateFogColor(object oPlayer, int nSunFogColor, int nMoonFogColor)
Update Sun and Moon Fog Color for oPlayer only.
const int NWNX_PLAYER_PLATFORM_INVALID
struct NWNX_Player_JournalEntry NWNX_Player_GetJournalEntry(object oPlayer, string questTag)
Returns a struct containing a journal entry that can then be modified.
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.
void NWNX_Player_ForcePlaceableInventoryWindow(object player, object placeable)
Force opens the target object's inventory for the player.
const int NWNX_PLAYER_PLATFORM_MAC_X86
void NWNX_Player_SetCustomToken(object oPlayer, int nCustomTokenNumber, string sTokenValue)
Set nCustomTokenNumber to sTokenValue for oPlayer only.
const int NWNX_PLAYER_TIMING_BAR_TRAP_FLAG
const int NWNX_PLAYER_TIMING_BAR_TRAP_DISARM
void NWNX_Player_MusicBackgroundChangeDay(object player, int track)
Changes the daytime music track for the given player only.
void NWNX_Player_UpdateWind(object oPlayer, vector vDirection, float fMagnitude, float fYaw, float fPitch)
Update wind for oPlayer only.
void NWNX_Player_ReloadColorPalettes(object oPlayer)
Reloads the color palettes for oPlayer.
const int NWNX_PLAYER_TIMING_BAR_REST
const int NWNX_PLAYER_PLATFORM_WINDOWS_X64
string NWNX_Player_GetBicFileName(object player)
Get the name of the .bic file associated with the player's character.
void NWNX_CallFunction(string pluginName, string functionName)
Scripting interface to NWNX.
const int NWNX_PLAYER_PLATFORM_ANDROID_ARM64
string NWNX_GetReturnValueString()
Returns the specified type from the c++ side.
void NWNX_PushArgumentString(string value)
Pushes the specified type to the c++ side.
const int NWNX_PLAYER_TIMING_BAR_CUSTOM
void NWNX_Player_MusicBackgroundChangeNight(object player, int track)
Changes the nighttime music track for the given player only.
void NWNX_Player_SetResManOverride(object oPlayer, int nResType, string sOldResName, string sNewResName)
Override sOldResName with sNewResName of nResType for oPlayer.
void NWNX_Player_SetAlwaysWalk(object player, int bWalk=TRUE)
Sets whether the player should always walk when given movement commands.
void NWNX_Player_MusicBattleStop(object player)
Stops the battle music for the given player only.
const int NWNX_PLAYER_PLATFORM_MICROSOFT_XBOXONE
void NWNX_Player_UpdateCharacterSheet(object player)
Refreshes the players character sheet.
void NWNX_PushArgumentObject(object value)
Pushes the specified type to the c++ side.
void NWNX_Player_SetObjectHiliteColorOverride(object oPlayer, object oObject, int nColor)
Override the hilite color of oObject for oPlayer only.
void NWNX_PushArgumentInt(int value)
Pushes the specified type to the c++ side.
int NWNX_Player_GetPlatformId(object oPlayer)
Returns the platform ID of the given player (NWNX_PLAYER_PLATFORM_*)
void NWNX_Player_FloatingTextStringOnCreature(object oPlayer, object oCreature, string sText, int bChatWindow=TRUE)
Display floaty text above oCreature for oPlayer only.
void NWNX_Player_UpdateItemName(object oPlayer, object oItem)
Force an item name to be updated.
struct NWNX_Player_QuickBarSlot NWNX_Player_GetQuickBarSlot(object player, int slot)
Gets the player's quickbar slot info.
void NWNX_Player_UpdateFogAmount(object oPlayer, int nSunFogAmount, int nMoonFogAmount)
Update Sun and Moon Fog Amount for oPlayer only.
string NWNX_Player_GetAreaExplorationState(object player, object area)
Get player's area exploration state.
int NWNX_Player_GetLanguage(object oPlayer)
Returns the game language of the given player (uses NWNX_DIALOG_LANGUAGE_*)
const int NWNX_PLAYER_PLATFORM_ANDROID_X64
const int NWNX_PLAYER_PLATFORM_ANDROID_ARM32
const int NWNX_PLAYER_PLATFORM_LINUX_X64
object NWNX_Player_GetTURD(object oPlayer)
Get the TURD for oPlayer.
void NWNX_Player_MusicBackgroundStop(object player)
Stops the background music for the given player only.
int NWNX_Player_AddCustomJournalEntry(object oPlayer, struct NWNX_Player_JournalEntry journalEntry, int nSilentUpdate=0)
Give a custom journal entry to oPlayer.
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_MAC_X64
void NWNX_Player_SetQuickBarSlot(object player, int slot, struct NWNX_Player_QuickBarSlot qbs)
Sets the player's quickbar slot info.
const int NWNX_PLAYER_PLATFORM_LINUX_ARM32
void NWNX_Player_SetPlaceableUsable(object player, object placeable, int usable)
Toggle a placeable's usable flag for the given player only.
void NWNX_Player_SetSpawnLocation(object oPlayer, location locSpawn)
Set the location oPlayer will spawn when logging in to the server.
void NWNX_Player_StopGuiTimingBar(object player, string script="")
Stop displaying a timing bar.
void NWNX_Player_ForcePlaceableExamineWindow(object player, object placeable)
Force display placeable examine window for player.
void NWNX_Player_SetCreatureNameOverride(object oPlayer, object oCreature, string sName)
Override the name of creature for player only.
object NWNX_GetReturnValueObject()
Returns the specified type from the c++ side.
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.
void NWNX_Player_MusicBackgroundStart(object player)
Starts the background music for the given player only.
const int NWNX_PLAYER_TIMING_BAR_TRAP_SET
object NWNX_Player_GetGameObject(object oPlayer)
Return's the currently-possessed game object of a player.
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_SetRestAnimation(object oPlayer, int nAnimation)
Override player's rest animation.
const int NWNX_PLAYER_TIMING_BAR_TRAP_RECOVER
void NWNX_PushArgumentFloat(float value)
Pushes the specified type to the c++ side.
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_ReloadTlk(object oPlayer)
Make the player reload it's TlkTable.
const int NWNX_PLAYER_PLATFORM_NINTENDO_SWITCH
const int NWNX_PLAYER_TIMING_BAR_LOCK
const int NWNX_PLAYER_PLATFORM_SONY_PS4
const int NWNX_PLAYER_PLATFORM_LINUX_X86
int NWNX_Player_PossessCreature(object oPossessor, object oPossessed, int bMindImmune=TRUE, int bCreateDefaultQB=FALSE)
Possesses a creature by temporarily making them a familiar.
void NWNX_Player_ToggleDM(object oPlayer, int bIsDM)
Toggle oPlayer's PlayerDM status.
int NWNX_Player_GetQuestCompleted(object player, string sQuestName)
Gets whether a quest has been completed by a player.
void NWNX_Player_MusicBattleStart(object player)
Starts the battle music for the given player only.
const int NWNX_PLAYER_TIMING_BAR_UNLOCK
void NWNX_Player_SetPersistentLocation(string sCDKeyOrCommunityName, string sBicFileName, object oWP, int bFirstConnectOnly=TRUE)
Place waypoints on module load representing where a PC should start.
void NWNX_Player_SetObjectMouseCursorOverride(object oPlayer, object oObject, int nCursor)
Override the mouse cursor of oObject for oPlayer only.
const int NWNX_PLAYER_PLATFORM_IOS