Xordac: 1 revision imported

2017-10-23T23:23:24Z

1 revision imported

New page

=Module Specific Function Category=

Functions found in #include files that are specific to a certain module and would not be of much use outside of that module.

<br /><br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
|
[[BringBack | BringBack ]]
| Brings a NPC back to life and transports them to a location.
|-
|
[[CanAfford | CanAfford ]]
| Determines if the player has enough gold in their inventory to pay for creating an item at the forge.
|-
|
[[CanAffordIt | CanAffordIt ]]
| This function checks to see if the player can afford to use the portal
|-
|
[[ClearArena | ClearArena ]]
| This function resets variables and clears the arenas in the fighter
|-
|
[[CreateSignPostNPC | CreateSignPostNPC ]]
| Spawns a creature using the action queue.
|-
|
[[DoOnce | DoOnce ]]
| Determines whether a something has been done before.
|-
|
[[GetArtifactItem | GetArtifactItem ]]
| Gets the Tag of a plot item for an quest in the Official Campaign
|-
|
[[GetBackpackMatch | GetBackpackMatch ]]
| Determines if the PC carries the proper items to create a new item.
|-
|
[[GetChapter | GetChapter ]]
| Gets the chapter number the player is currently in.
|-
|
[[GetComplexItem | GetComplexItem ]]
| Gets the Tag of a plot item for an quest in the Official Campaign
|-
|
[[GetFetchee | GetFetchee ]]
| Get a local object from the caller. Official campaign use only.
|-
|
[[GetFetchItem | GetFetchItem ]]
| Gets the tag of a plot item for a quest in the Official Campaign.
|-
|
[[GetForgeMatch | GetForgeMatch ]]
| Checks to see if the nPos item matches the current reward
|-
|
[[GetGreetingVar | GetGreetingVar ]]
| This variable keeps track of whether or not the player has talked to this henchman.
|-
|
[[GetHas2Q4PlotItem | GetHas2Q4PlotItem ]]
| Test if the object has the specified plot item
|-
|
[[GetIsMagical | GetIsMagical ]]
| Checks for predefined groups of magical effects on an item to determine if it is magical.
|-
|
[[GetItemPosition | GetItemPosition ]]
| Returns the position of a variable in an array containing a list of possible base types that can be created.
|-
|
[[GetLocalPlotIntFromCharacter | GetLocalPlotIntFromCharacter ]]
| Retrieves the generic plot flag off of a creature.
|-
|
[[GetMachineState | GetMachineState ]]
| Get the state of one lever
|-
|
[[GetNumberOfItems | GetNumberOfItems ]]
| Determines the number of items to create as treasure.
|-
|
[[GetPersonalItem | GetPersonalItem ]]
| Retrieves the string that is the identifier of the personal item for the assassin.
|-
|
[[GetPlotGiver | GetPlotGiver ]]
| Retrieves the assassin's target (victim).
|-
|
[[GetPlotItemTag | GetPlotItemTag ]]
| Returns the plot item's tag
|-
|
[[GetPlotJournal | GetPlotJournal ]]
| Retrieves the string that is the name of a journal entry.
|-
|
[[GetPlotRingTag | GetPlotRingTag ]]
| Retrieves the tag of the plot ring.
|-
|
[[GetPlotTag | GetPlotTag ]]
| Retrieves the plot tag for a specific quest.
|-
|
[[GetPlotToken | GetPlotToken ]]
| Retrieves the plot token number.
|-
|
[[GetPrisoner | GetPrisoner ]]
| Retrieves the prisoner object.
|-
|
[[GetQuestItemTag | GetQuestItemTag ]]
| Returns the quest item's tag.
|-
|
[[GetQuestStatus | GetQuestStatus ]]
| Returns a PC's quest status.
|-
|
[[GetQuestTag | GetQuestTag ]]
| Gets the giver's quest tag.
|-
|
[[GetQuestVarname | GetQuestVarname ]]
| Gets the NPC's local variable name for the given quest.
|-
|
[[GetRange | GetRange ]]
| Determines whether the HD falls in a range category.
|-
|
[[GetRewardItemTag | GetRewardItemTag ]]
| Returns the reward item tag.
|-
|
[[GetRingGivenTo | GetRingGivenTo ]]
| Retrieves the PC that the ring was given to.
|-
|
[[GetStoryItem | GetStoryItem ]]
| Gets a string representing a plot item from the Official Campaign
|-
|
[[GetUniform | GetUniform ]]
| Gets the tag of a guard's uniform.
|-
|
[[GetValidItem | GetValidItem ]]
| Gets a name of an item that can made at the Forge in the official campaign.
|-
|
[[GetValidItemCost | GetValidItemCost ]]
| Used to determine the cost of making an item at the forge.
|-
|
[[GetVictim | GetVictim ]]
| Specifies the assassinâs victim in original campaign.
|-
|
[[Give2Q4PlotItem | Give2Q4PlotItem ]]
| Gives a Luskan plot item to the PC speaker.
|-
|
[[GiveChapterRewardItem | GiveChapterRewardItem ]]
| Gives a reward item to the player.
|-
|
[[GiveFetchItemToPC | GiveFetchItemToPC ]]
| Gives the fetch item to the PC.
|-
|
[[GivePlayerPersonalItem | GivePlayerPersonalItem ]]
| Gives the personal item of an assassination victim to the player.
|-
|
[[GiveQuestItem | GiveQuestItem ]]
| Create the quest item on the player.
|-
|
[[GiveRewardItem | GiveRewardItem ]]
| Creates a reward item on the PC.
|-
|
[[HasChapterRewardItem | HasChapterRewardItem ]]
| Checks if player has the chapter reward item.
|-
|
[[HasPersonalItem | HasPersonalItem ]]
| Checks if the player has the henchmanâs personal item.
|-
|
[[HasPlotItem | HasPlotItem ]]
| Checks the PC's party for an item.
|-
|
[[HasQuestItem | HasQuestItem ]]
| Checks if the PC's party possesses a given quest item.
|-
|
[[HasRewardItem | HasRewardItem ]]
| Checks the PC's party for the reward item.
|-
|
[[HasSpell | HasSpell ]]
| Checks if caller has spell
|-
|
[[IsRecall | IsRecall ]]
| Recalls a player through the use of Recall Stones.
|-
|
[[MakeWay | MakeWay ]]
| Builds the tag for the waypoint to walk to.
|-
|
[[NextTag | NextTag ]]
| Gets the tag of the next waypoint to walk to.
|-
|
[[PCAcceptedPlot | PCAcceptedPlot ]]
| Returns true if the player accepted the assassin plot.
|-
|
[[PlayerHasArtifactItem | PlayerHasArtifactItem ]]
| Checks if a PC has the artifact item.
|-
|
[[PlayerHasComplexItem | PlayerHasComplexItem ]]
| Checks if a PC has the complex item.
|-
|
[[PlayerHasFetchItem | PlayerHasFetchItem ]]
| Checks if a PC has the fetch item.
|-
|
[[PlayerHasHead | PlayerHasHead ]]
| Checks if a PC has the head of the assassination victim.
|-
|
[[PlayerHasPersonalItem | PlayerHasPersonalItem ]]
| Checks if a PC has the personal item of the assassination victim.
|-
|
[[PlayerHasRing | PlayerHasRing ]]
| Checks if a PC has the ring used in the rescue plot.
|-
|
[[PlayerHasStoryItem | PlayerHasStoryItem ]]
| Checks if a PC has the story item.
|-
|
[[PlayerWearsUniform | PlayerWearsUniform ]]
| Checks if a PC has a certain uniform equipped.
|-
|
[[PlotGiverDead | PlotGiverDead ]]
| Returns whether or not the assassin plot giver is dead.
|-
|
[[SetArtifactItem | SetArtifactItem ]]
| Stores the tag of the artifact item in a local string.
|-
|
[[SetAssassinHead | SetAssassinHead ]]
| Stores the tag of the assassin victimâs head in a local string.
|-
|
[[SetComplexItem | SetComplexItem ]]
| Stores the tag of the complex item in a local string.
|-
|
[[SetDoubleCrosserName | SetDoubleCrosserName ]]
| Used to track the name of the PC that double-crosses an NPC during a plot of the Original Campaign.
|-
|
[[SetFetchee | SetFetchee ]]
| Sets the PC that is running an errand for an NPC during the original module.
|-
|
[[SetFetchItem | SetFetchItem ]]
| Specifies what item the PC needs to fetch in the Original Campaign.
|-
|
[[SetGreetingVar | SetGreetingVar ]]
| This variable keeps track of whether or not the player has talked to this henchman.
|-
|
[[SetLocalPlotIntOnCharacter | SetLocalPlotIntOnCharacter ]]
| Sets a plot-specific integer on a creature.
|-
|
[[SetMachineState | SetMachineState ]]
| When PC uses specific machine in City of Luskan in Original Campaign, sets the machine for operation or not.
|-
|
[[SetOnQuest | SetOnQuest ]]
| Sets that a PC has taken a quest
|-
|
[[SetPersonalItem | SetPersonalItem ]]
| Stored the identifier to a personal item of an assassin.
|-
|
[[SetPlotGiver | SetPlotGiver ]]
| Stores the victim of an assassin.
|-
|
[[SetPlotJournal | SetPlotJournal ]]
| Puts the current status of a plot during the Rescue mission of the Original Campaign.
|-
|
[[SetPlotRing | SetPlotRing ]]
| Stores the tag that represents the plot ring.
|-
|
[[SetPlotTag | SetPlotTag ]]
| Specifies the name of the item used in the Artifact plot line in the Original Campaign.
|-
|
[[SetPlotToken | SetPlotToken ]]
| Stores the plot token to a value.
|-
|
[[SetPrisoner | SetPrisoner ]]
| Stores the prisoner in a local variable.
|-
|
[[SetQuestDone | SetQuestDone ]]
| Sets a quest as finished or done.
|-
|
[[SetRingGivenTo | SetRingGivenTo ]]
| Stores the PC that the ring was given to.
|-
|
[[SetSpawnInLocals | SetSpawnInLocals ]]
| Sets local variables on creatures to support the SetSpawnInCondition function.
|-
|
[[SetStoryItem | SetStoryItem ]]
| Stores the name of an item for use in the Original Campaign.
|-
|
[[SetStoryVar | SetStoryVar ]]
| Used to track the current storyline for the henchman a PC has working for him. Original Campaign.
|-
|
[[SetUniform | SetUniform ]]
| Specifies the name of the uniform to be taken by the player during the original campaign.
|-
|
[[SetValidItem | SetValidItem ]]
| Specifies the location in a PC's inventory where a valid item exists for the Smithy plot in original campaign.
|-
|
[[SetValidItemCost | SetValidItemCost ]]
| Specifies the amount of gold the combined item is worth during the Smith plot in original campaign.
|-
|
[[SetValidItemCostToken | SetValidItemCostToken ]]
| Specifies the amount of gold extra that is needed to create a magical item during the Smithy plot line of the original campaign.
|-
|
[[SetVictim | SetVictim ]]
| Specifies name of NPC to be assassinated.
|-
|
[[TakePlotItem | TakePlotItem ]]
| Take the plot item from oPC's party.
|-
|
[[TakeQuestItem | TakeQuestItem ]]
| Removes a quest item from a PC's party.
|-
|
[[VictimDead | VictimDead ]]
| Determines whether the victim is dead.
|-
|
[[VictimDeadButNoItems | VictimDeadButNoItems ]]
| Determines whether the victim is dead but oPC does not carrying either the head or the personal item, otherwise FALSE.
|}

----
[[Category:Functions]]
[[Category:Function_Categories]]

Category:Module Specific Functions - Revision history

Xordac: 1 revision imported