|
void | AddJournalQuestEntry (string categoryTag, int entryId, bool allowOverrideHigher=false) |
| Adds an entry to the journal of all players in the module.
See NwPlayer.AddJournalQuestEntry to add a journal entry to a specific player/party. More...
|
|
void | ClearTextureOverride (string texName) |
| Removes the override for the specified texture, reverting to the original texture. More...
|
|
void | DestroyCampaignDatabase (string campaign) |
| Deletes the entire campaign database, if it exists. More...
|
|
void | EndGame (string endMovie) |
| Ends the current running game, plays the specified movie then returns all players to the main menu. More...
|
|
void | ExportAllCharacters () |
| Forces all players who are currently game to have their characters exported to their respective directories i.e. LocalVault/ServerVault/ etc. More...
|
|
T | GetCampaignVariable< T > (string campaign, string name) |
| Gets the specified global campaign variable. More...
|
|
IEnumerable< NwObject > | GetLastCreatedObjects () |
| Gets the last objects that were created in the module. Use LINQ to skip or limit the query. More...
|
|
NwWaypoint? | GetWaypointByTag (string tag) |
| Finds the specified waypoint with the given tag. More...
|
|
void | MoveObjectToLimbo (NwGameObject gameObject) |
| Moves the specified NwGameObject from its current location/owner to limbo. More...
|
|
override? Guid | PeekUUID () |
| Attempts to get the UUID of this object, if assigned. More...
|
|
SQLQuery | PrepareCampaignSQLQuery (string database, string query) |
| Sets up a SQL Query for the specified campaign database.
This will NOT run the query; only make it available for parameter binding.
To run the query, you need to call SQLQuery.Execute even if you do not expect result data.
More...
|
|
SQLQuery | PrepareSQLQuery (string query) |
| Sets up a SQL Query for this module.
This will NOT run the query; only make it available for parameter binding.
To run the query, you need to call SQLQuery.Execute even if you do not expect result data.
More...
|
|
void | RefreshClientObjects (NwGameObject gameObject) |
| Causes all players in the module to refresh client object information about the specified game object. More...
|
|
void | SendMessageToAllDMs (string message) |
|
void | SendMessageToAllDMs (string message, Color color) |
| Broadcasts a message to the DM channel, sending a message to all DMs on the server. More...
|
|
void | SetTextureOverride (string oldTexName, string newName) |
| Makes all online PCs load a new texture instead of another. More...
|
|
async Task | AddActionToQueue (System.Action action) |
| Inserts the function call aCommand into the Action Queue, ensuring the calling object will perform actions in a particular order. More...
|
|
async Task | ClearActionQueue (bool clearCombatState=false) |
| Clear all the object's actions. More...
|
|
void | ClearEventSubscriptions () |
| Clears any event subscriptions associated with this object. More...
|
|
bool | Equals (NwObject? other) |
|
override bool | Equals (object? obj) |
|
void | ForceRefreshUUID () |
|
string | GetEventScript (EventScriptType eventType) |
| Gets the script assigned to run for the specified object event. More...
|
|
override int | GetHashCode () |
|
T | GetObjectVariable< T > (string name) |
| Gets the specified object variable for this object. More...
|
|
bool | IsEventLocked (EventScriptType eventType) |
| Gets a value indicating whether the event script can be modified for the specified event. More...
|
|
Json | SerializeToJson (bool saveObjectState) |
| Serializes this game object to a json representation More...
|
|
void | SetEventScript (EventScriptType eventType, string? script) |
| Sets the script to be run on the specified object event. More...
|
|
async Task | SpeakString (string message, TalkVolume talkVolume=TalkVolume.Talk, bool queueAsAction=false) |
| Instructs this object to speak. More...
|
|
override string | ToString () |
| The ID of this object as a string. Can be used in StringExtensions.ParseObject while the object is alive.
This cannot be used across server restarts. See UUID for a persistent unique identifier. More...
|
|
bool | TryGetUUID (out Guid uid) |
| Attempts to get the UUID for this object, assigning a new ID if it does not already exist.
More...
|
|
async Task | WaitForObjectContext () |
| Notifies then awaits for this object to become the current active object for the purpose of implicitly assigned values (e.g. effect creators).
If the current active object is already this object, then the code runs immediately. Otherwise, it will be run with all other closures.
This is the async equivalent of AssignCommand in NWScript. More...
|
|
|
int | AbilityPenaltyLimit [get, set] |
| Gets or sets the max possible ability score penalty from temporary effects/items (Default: 30). More...
|
|
IEnumerable< NwArea > | Areas [get] |
| Gets all active areas in the module. More...
|
|
int | AttackBonusLimit [get, set] |
| Gets or sets the max possible attack bonus from temporary effects/items (Default: 20). More...
|
|
int | DamageBonusLimit [get, set] |
| Gets or sets the max possible damage bonus from temporary effects/items (Default: 100). More...
|
|
GameDifficulty | GameDifficulty [get] |
| Gets the current server difficulty setting. More...
|
|
int | GetAbilityBonusLimit [get, set] |
| Gets or sets the max possible ability score bonus from temporary effects/items (Default: 12). More...
|
|
bool | IsDawn [get] |
| Gets a value indicating whether it is currently dawn. More...
|
|
bool | IsDay [get] |
| Gets a value indicating whether it is currently day. More...
|
|
bool | IsDusk [get] |
| Gets a value indicating whether it is currently dusk. More...
|
|
bool | IsNight [get] |
| Gets a value indicating whether it is currently night. More...
|
|
IEnumerable< NwGameObject > | LimboGameObjects [get] |
| Gets all objects currently stored in limbo. More...
|
|
int | MaxHenchmen [get, set] |
| Gets or sets the maximum number of henchmen. More...
|
|
Action< ModuleEvents.OnAcquireItem > | OnAcquireItem |
|
Action< ModuleEvents.OnActivateItem > | OnActivateItem |
|
Action< OnAssociateAdd > | OnAssociateAdd |
|
Action< OnAssociateRemove > | OnAssociateRemove |
|
Action< OnBarterEnd > | OnBarterEnd |
|
Action< OnBarterStart > | OnBarterStart |
|
Action< OnCalendarTimeChange > | OnCalendarTimeChange |
|
Action< OnChatMessageSend > | OnChatMessageSend |
|
Action< OnCheckEffectImmunity > | OnCheckEffectImmunity |
|
Action< OnClientConnect > | OnClientConnect |
|
Action< OnClientDisconnect > | OnClientDisconnect |
|
Action< ModuleEvents.OnClientEnter > | OnClientEnter |
|
Action< ModuleEvents.OnClientLeave > | OnClientLeave |
|
Action< OnClientLevelUpBegin > | OnClientLevelUpBegin |
|
Action< OnCombatDRBroken > | OnCombatDRBroken |
|
Action< OnCombatModeToggle > | OnCombatModeToggle |
|
Action< OnCombatRoundStart > | OnCombatRoundStart |
|
Action< OnCombatStatusChange > | OnCombatStatusChange |
|
Action< OnCreatureAttack > | OnCreatureAttack |
|
Action< OnCreatureCheckProficiencies > | OnCreatureCheckProficiencies |
|
Action< OnCreatureDamage > | OnCreatureDamage |
|
Action< ModuleEvents.OnCutsceneAbort > | OnCutsceneAbort |
|
Action< OnDebugPlayVisualEffect > | OnDebugPlayVisualEffect |
|
Action< OnDebugRunScript > | OnDebugRunScript |
|
Action< OnDebugRunScriptChunk > | OnDebugRunScriptChunk |
|
Action< OnDetectModeUpdate > | OnDetectModeUpdate |
|
Action< OnDisarmWeapon > | OnDisarmWeapon |
|
Action< OnDispelMagicApply > | OnDispelMagicApply |
|
Action< OnDMAppear > | OnDMAppear |
|
Action< OnDMChangeDifficulty > | OnDMChangeDifficulty |
|
Action< OnDMDisableTrap > | OnDMDisableTrap |
|
Action< OnDMDisappear > | OnDMDisappear |
|
Action< OnDMDumpLocals > | OnDMDumpLocals |
|
Action< OnDMForceRest > | OnDMForceRest |
|
Action< OnDMGetFactionReputation > | OnDMGetFactionReputation |
|
Action< OnDMGetVariable > | OnDMGetVariable |
|
Action< OnDMGiveAlignment > | OnDMGiveAlignment |
|
Action< OnDMGiveGold > | OnDMGiveGold |
|
Action< OnDMGiveItem > | OnDMGiveItem |
|
Action< OnDMGiveLevel > | OnDMGiveLevel |
|
Action< OnDMGiveXP > | OnDMGiveXP |
|
Action< OnDMGoTo > | OnDMGoTo |
|
Action< OnDMHeal > | OnDMHeal |
|
Action< OnDMJumpAllPlayersToPoint > | OnDMJumpAllPlayersToPoint |
|
Action< OnDMJumpTargetToPoint > | OnDMJumpTargetToPoint [get] |
|
Action< OnDMJumpToPoint > | OnDMJumpToPoint |
|
Action< OnDMKill > | OnDMKill |
|
Action< OnDMLimbo > | OnDMLimbo |
|
Action< OnDMPlayerDMLogin > | OnDMPlayerDMLogin |
|
Action< OnDMPlayerDMLogout > | OnDMPlayerDMLogout |
|
Action< OnDMPossess > | OnDMPossess |
|
Action< OnDMPossessFullPower > | OnDMPossessFullPower |
|
Action< OnDMSetDate > | OnDMSetDate |
|
Action< OnDMSetFaction > | OnDMSetFaction |
|
Action< OnDMSetFactionReputation > | OnDMSetFactionReputation |
|
Action< OnDMSetStat > | OnDMSetStat |
|
Action< OnDMSetTime > | OnDMSetTime |
|
Action< OnDMSetVariable > | OnDMSetVariable |
|
Action< OnDMSpawnObject > | OnDMSpawnObject |
|
Action< OnDMSpawnTrapOnObject > | OnDMSpawnTrapOnObject |
|
Action< OnDMTakeItem > | OnDMTakeItem |
|
Action< OnDMToggleAI > | OnDMToggleAI |
|
Action< OnDMToggleImmortal > | OnDMToggleImmortal |
|
Action< OnDMToggleInvulnerable > | OnDMToggleInvulnerable |
|
Action< OnDMToggleLock > | OnDMToggleLock |
|
Action< OnDMViewInventory > | OnDMViewInventory |
|
Action< OnDoListenDetection > | OnDoListenDetection |
|
Action< OnDoorSetOpenState > | OnDoorSetOpenState |
|
Action< OnDoSpotDetection > | OnDoSpotDetection |
|
Action< OnEffectApply > | OnEffectApply |
|
Action< OnEffectRemove > | OnEffectRemove |
|
Action< OnExamineObject > | OnExamineObject |
|
Action< OnExamineTrap > | OnExamineTrap |
|
Action< OnFamiliarPossess > | OnFamiliarPossess |
|
Action< OnFamiliarUnpossess > | OnFamiliarUnpossess |
|
Action< OnHeal > | OnHeal |
|
Action< OnHealKitUse > | OnHealKitUse |
|
Action< ModuleEvents.OnHeartbeat > | OnHeartbeat |
|
Action< OnInventoryGoldAdd > | OnInventoryGoldAdd |
|
Action< OnInventoryGoldRemove > | OnInventoryGoldRemove |
|
Action< OnInventoryItemAdd > | OnInventoryItemAdd |
|
Action< OnInventoryItemRemove > | OnInventoryItemRemove |
|
Action< OnItemEquip > | OnItemEquip |
|
Action< OnItemInventoryClose > | OnItemInventoryClose |
|
Action< OnItemInventoryOpen > | OnItemInventoryOpen |
|
Action< OnItemPayToIdentify > | OnItemPayToIdentify |
|
Action< OnItemScrollLearn > | OnItemScrollLearn |
|
Action< OnItemUnequip > | OnItemUnequip |
|
Action< OnItemUse > | OnItemUse |
|
Action< OnItemValidateEquip > | OnItemValidateEquip |
|
Action< OnItemValidateUse > | OnItemValidateUse |
|
Action< OnLevelDown > | OnLevelDown |
|
Action< OnLevelUp > | OnLevelUp |
|
Action< OnLevelUpAutomatic > | OnLevelUpAutomatic |
|
Action< OnLoadCharacterFinish > | OnLoadCharacterFinish |
|
Action< OnMapPinAddPin > | OnMapPinAddPin |
|
Action< OnMapPinChangePin > | OnMapPinChangePin |
|
Action< OnMapPinDestroyPin > | OnMapPinDestroyPin |
|
Action< ModuleEvents.OnModuleLoad > | OnModuleLoad |
|
Action< ModuleEvents.OnModuleStart > | OnModuleStart |
|
Action< ModuleEvents.OnNuiEvent > | OnNuiEvent |
|
Action< OnObjectUse > | OnObjectUse |
|
Action< OnPartyEvent > | OnPartyEvent |
|
Action< ModuleEvents.OnPlayerChat > | OnPlayerChat |
|
Action< ModuleEvents.OnPlayerDeath > | OnPlayerDeath |
|
Action< ModuleEvents.OnPlayerDying > | OnPlayerDying |
|
Action< ModuleEvents.OnPlayerEquipItem > | OnPlayerEquipItem |
|
Action< ModuleEvents.OnPlayerGuiEvent > | OnPlayerGuiEvent |
|
Action< ModuleEvents.OnPlayerLevelUp > | OnPlayerLevelUp |
|
Action< OnPlayerQuickChat > | OnPlayerQuickChat |
|
Action< ModuleEvents.OnPlayerRespawn > | OnPlayerRespawn |
|
Action< ModuleEvents.OnPlayerRest > | OnPlayerRest |
|
Action< ModuleEvents.OnPlayerTarget > | OnPlayerTarget [get] |
|
Action< ModuleEvents.OnPlayerTileAction > | OnPlayerTileAction |
|
Action< ModuleEvents.OnPlayerUnequipItem > | OnPlayerUnequipItem |
|
Action< OnServerCharacterSave > | OnServerCharacterSave |
|
Action< OnServerSendArea > | OnServerSendArea |
|
Action< OnSpellAction > | OnSpellAction |
|
Action< OnSpellBroadcast > | OnSpellBroadcast |
|
Action< OnSpellCast > | OnSpellCast |
|
Action< OnSpellInterrupt > | OnSpellInterrupt |
|
Action< OnSpellSlotClear > | OnSpellSlotClear |
|
Action< OnSpellSlotMemorize > | OnSpellSlotMemorize |
|
Action< OnStealthModeUpdate > | OnStealthModeUpdate |
|
Action< OnStoreRequestBuy > | OnStoreRequestBuy |
|
Action< OnStoreRequestSell > | OnStoreRequestSell |
|
Action< OnTriggerEnter > | OnTriggerEnter |
|
Action< ModuleEvents.OnUnacquireItem > | OnUnacquireItem |
|
Action< OnUseFeat > | OnUseFeat |
|
Action< ModuleEvents.OnUserDefined > | OnUserDefined |
|
Action< OnUseSkill > | OnUseSkill |
|
uint | PlayerCount [get] |
| Gets the current player count. More...
|
|
IEnumerable< NwPlayer > | Players [get] |
| Gets all current online players. More...
|
|
int | SavingThrowBonusLimit [get, set] |
| Gets or sets the max possible saving throw bonus from temporary effects/items (Default: 20). More...
|
|
int | SkillBonusLimit [get, set] |
| Gets or sets the max possible skill bonus from temporary effects/items (Default: 50). More...
|
|
Location | StartingLocation [get] |
| Gets the starting location for new players. More...
|
|
int | XPScale [get, set] |
| Gets or sets the XP scale for this module. Must be a value between 0-200. More...
|
|
string | Description [get, set] |
| Gets or sets the description for this object. More...
|
|
static EventService | EventService = null! [get] |
|
bool | HasUUID [get] |
| Gets a value indicating whether this object has an assigned UUID. More...
|
|
bool | IsValid [get] |
| Gets a value indicating whether this is a valid object. More...
|
|
IEnumerable< ObjectVariable > | LocalVariables [get] |
| Gets all local variables assigned on this object. More...
|
|
string | Name [get, set] |
| Gets or sets the name of this object. More...
|
|
static Lazy< ObjectVisibilityService > | ObjectVisibilityService = null! [get] |
|
string | OriginalDescription [get] |
| Gets the original description for this object as defined in the toolset. More...
|
|
static ResourceManager | ResourceManager = null! [get] |
|
string | ResRef [get] |
| Gets the resource reference used to create this object. More...
|
|
string | Tag [get, set] |
| Gets or sets the tag for this object. More...
|
|
Guid | UUID [get] |
| Gets the globally unique identifier for this object. More...
|
|
static VirtualMachine | VirtualMachine = null! [get] |
|
The root container object for all areas and module entities.