Difference between revisions of "IsPlayable"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Odessa
(4.5.7 update)
imported>Pintocat
m
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{Function
  |origin = NVSE
  |origin = NVSE
  |summary = Returns true (1) if the specified form or [[calling reference]], which may be an armor, weapon or ammo, has the playable flag. Added by NVSE 4.2, expanded by NVSE 4.5.
  |summary = Returns true (1) if the specified form or [[calling reference]], which may be an armor, weapon, ammo or race, has the playable flag. Added by NVSE 4.2 (see notes).
  |name = IsPlayable
  |name = IsPlayable
  |referenceType = reference
  |referenceType = reference
Line 17: Line 17:
endif
endif
</pre>
</pre>
 
==Form Types==
These form types can be Playable:
<pre>10: Hair (not supported by this function; see LNIsPlayable)
11: Eyes (not supported by this function; see LNIsPlayable)
12: Race
24: Armor
40: Weapon
41: Ammo
86: Perk (not supported by this function; see LNIsPlayable)</pre>
==Note==
==Note==
* In NVSE 4.2, this function only worked for armor- 4.5.7 has expanded it to work with weapons and ammo as well.
* In NVSE 4.2, this function only worked for armor- 4.5.7 has expanded it to work with weapons and ammo as well.
* Since NVSE 5.0.2, this function also supports races.
==See Also==
==See Also==
*[[SetIsPlayable]]
*[[SetIsPlayable]]

Latest revision as of 10:49, 26 January 2017

< [[::Category:Functions|Category:Functions]]

A function added by the New Vegas Script Extender.

Description

Returns true (1) if the specified form or calling reference, which may be an armor, weapon, ammo or race, has the playable flag. Added by NVSE 4.2 (see notes).

Syntax

[help]
(bool) IsPlayable ToCheck:form

Example

if IsPlayable Weap10mmPistol
    ; The weapon is playable
endif

Form Types

These form types can be Playable:

10: Hair (not supported by this function; see LNIsPlayable)
11: Eyes (not supported by this function; see LNIsPlayable)
12: Race
24: Armor
40: Weapon
41: Ammo
86: Perk (not supported by this function; see LNIsPlayable)

Note

  • In NVSE 4.2, this function only worked for armor- 4.5.7 has expanded it to work with weapons and ammo as well.
  • Since NVSE 5.0.2, this function also supports races.

See Also