Warhorse ScripBind documentation
ContentsIndexHome
PreviousUpNext
C_ScriptBind_PickableItem Methods

The methods of the C_ScriptBind_PickableItem class are listed here.

 
Name 
Description 
 
 
 
Syntax: Item.CanPickUp( ScriptHandle userId )
Checks if the item can be picked up by the user.
 
 
Syntax: Item.CanUse( ScriptHandle userId )
Checks if the item can be used by the user.
 
 
Syntax: Item.GetExtensionParams( const char *extension, SmartScriptTable params )
Gets extension parameters.
 
 
Syntax: Item.GetHealth()
Gets item health.
 
 
Syntax: Item.GetId()
Gets item id
 
 
Syntax: Item.GetMaxHealth()
Gets the maximum item health.
 
 
Syntax: Item.GetMountedAngleLimits()
Gets the mounted angle limits for the item.
 
 
Syntax: Item.GetMountedDir()
Gets the mounted direction for the item.
 
 
Syntax: Item.GetOwnerId()
Gets the identifier of the item's owner.
 
 
Syntax: Item.GetParams()
Gets the item parameters.
 
 
Syntax: Item.GetStats()
Gets the item statistics.
 
 
Syntax: Item.GetUIName()
Gets the UI name.
 
 
Syntax: Item.IsDestroyed()
Event that occurs when the item is destroyed.
 
 
Syntax: Item.IsFromShop()
Returns true if the item is owner by some shop and can be bought instead of picked
 
 
Syntax: Item.IsMounted()
Checks if the item is mounted.
 
 
Syntax: Item.IsOversized()
Returns true if the item is too big to be picket up
 
 
Syntax: Item.IsUsed()
Checks if the item is used.
 
 
Syntax: Item.OnHit( SmartScriptTable hitTable )
Events that occurs when the item is hit.
 
 
Syntax: Item.OnUsed( ScriptHandle userId )
Events that occurs when the item is used.
 
 
Syntax: Item.PlayAnimation( const char *animationName )
Plays the specified animation.
 
 
Syntax: Item.Quiet()
Quiets the item.
 
 
Syntax: Item.Reset()
Resets the item.
 
 
Syntax: Item.Select( bool select )
Selects/deselects the item.
 
 
Syntax: Item.SetExtensionActivation( const char *extension, bool activation )
Activates/deactivates an extension.
 
 
Syntax: Item.SetExtensionParams( const char *extension, SmartScriptTable params )
Sets extension parameters.
 
 
Syntax: Item.SetMountedAngleLimits( float min_pitch, float max_pitch, float yaw_range )
Sets the mounted angle limits (yaw-pitch).
 
 
Syntax: Item.StartUse( ScriptHandle userId )
The specified user now will start to use the item.
 
 
Syntax: Item.StopUse( ScriptHandle userId )
The specified user now will stop to use the item.
 
 
Use 
Syntax: Item.Use( ScriptHandle userId )
The specified user now will use the item.
 
Copyright (c) 2012. All rights reserved.