Difference between revisions of "GetIsID"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>JOG
(Added example)
imported>DragoonWraith
(correcting)
 
(6 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''Syntax:'''
'''Syntax:'''
   GetIsID CompareActorID
   GetIsID ObjectID


Returns 1 if the actor is CompareActorID.  
Returns 1 if the calling object is a reference to ObjectID. The parameter for this function is a base object ID, as defined in the object window.  


'''Example:'''
'''Example:'''
Line 20: Line 20:
     endif
     endif
   end
   end
== Note ==
* The script compiler assumes that <tt>player</tt> actually refers to <tt>playerRef</tt>. Therefore, <tt>GetIsID player</tt> will never return true. Use <tt>GetIsReference player</tt> instead.


[[Category: Functions]]
[[Category: Functions]]
[[Category:Functions (CS)]]
[[Category: Functions (CS 1.0)]]
[[Category: Actor State Functions]]
[[Category: Actor State Functions]]
[[Category: Actor State Functions (CS 1.0)]]
[[Category: Condition Functions]]
[[Category: Condition Functions]]
[[Category: Condition Functions (CS 1.0)]]
<!-- Begin Search Terms
Get
Is
ID
End Search Terms -->

Latest revision as of 17:16, 9 September 2010

Syntax:

 GetIsID ObjectID

Returns 1 if the calling object is a reference to ObjectID. The parameter for this function is a base object ID, as defined in the object window.

Example:

 Begin Onequip Player              ; One script for a whole set of armor
   if GetIsID mycuirass
      message "Cuirass equipped"
   elseif GetIsID myboots
      message "Boots equipped"
   elseif GetIsID mygauntlets
      message "Gauntlets equipped"
   elseif GetIsID mygreaves
      message "Greaves equipped"    
   elseif GetIsID myhelmet
      message "Helmet equipped"
   else
      message "Shield equipped"
   endif
 end

Note[edit | edit source]

  • The script compiler assumes that player actually refers to playerRef. Therefore, GetIsID player will never return true. Use GetIsReference player instead.