Difference between revisions of "GetPlotEntryName"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m (Completing definition, expanding description, removed broken links) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
| − | |name=GetPlotEntryName | + | |name = GetPlotEntryName |
| − | |brief=Returns the name of a plot entry | + | |brief = Returns the StrRef of name of a plot entry |
| − | |param1type=string | + | |param1type = string |
| − | |param1name=strPlot | + | |param1name = strPlot |
| − | |param1desc= | + | |param1desc = the GUID or ResRef of the plot |
| − | |returntype=int | + | |returntype = int |
| − | |returndesc= | + | |returndesc = the StrRef of the name of the plot |
| − | |sourcefile=script.ldf | + | |sourcefile = script.ldf |
| − | |sourcemodule= | + | |sourcemodule = |
}} | }} | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | Returns | + | Returns the StrRef (string ID) of the localized name of the plot entry. [[GetStringByStringId]] or [[GetTlkTableString]] can be used to obtain the actual name from the StrRef. |
| − | + | <!-- | |
| − | <!-- == Remarks == --> | + | == Remarks == --> |
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | + | <!-- | |
| − | <!-- == Examples == --> | + | == Examples == --> |
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| + | <!-- | ||
| + | == See also == --> | ||
| + | <!-- This section contains links to articles, functions or constant groups. --> | ||
| − | + | [[Category:Plot manager functions]] | |
| − | + | ||
| − | + | ||
| − | [[Category: Plot manager functions]] | + | |
Latest revision as of 00:13, 17 July 2011
Returns the StrRef of name of a plot entry
- Parameters:
- strPlot
- the GUID or ResRef of the plot
- Returns:
- the StrRef of the name of the plot
- Source:
- script.ldf
Description
Returns the StrRef (string ID) of the localized name of the plot entry. GetStringByStringId or GetTlkTableString can be used to obtain the actual name from the StrRef.
