ItemUseParameters Interface Reference

Set of parameters used by TryUseItemOverrideParams. More...

Public Member Functions
proto external IEntity	GetEntity ()
proto external void	SetEntity (IEntity entity)
proto external bool	ShouldAllowMovementDuringAction ()
proto external void	SetAllowMovementDuringAction (bool allowed)
proto external bool	ShouldKeepInHandAfterSuccess ()
proto external void	SetKeepInHandAfterSuccess (bool keep)
proto external bool	ShouldKeepGadgetVisible ()
proto external void	SetKeepGadgetVisible (bool keepVisible)
proto external bool	IsMainUserOfTheItem ()
proto external void	SetIsMainUserOfTheItem (bool isMainUser)
proto external int	GetCommandID ()
proto external void	SetCommandID (int cmdID)
proto external int	GetCommandIntArg ()
proto external void	SetCommandIntArg (int cmdIntArg)
proto external float	GetCommandFloatArg ()
proto external void	SetCommandFloatArg (float cmdFloatArg)
proto external float	GetMaxAnimLength ()
proto external void	SetMaxAnimLength (float maxAnimLength)
proto external int	GetIntParam ()
proto external void	SetIntParam (int intParam)
proto external PointInfo	GetAlignmentPoint ()
proto external void	SetAlignmentPoint (PointInfo pointWS)
proto external int	GetItemGraphEntryPoint ()
proto external void	SetItemGraphEntryPoint (string itemGraphEntryPoint)
proto external string	GetCharGraphBindingName ()
proto external void	SetCharGraphBindingName (string charGraphBindingName)
proto external void	Reset ()

Detailed Description

Set of parameters used by TryUseItemOverrideParams.

Member Function Documentation

GetAlignmentPoint()

proto external PointInfo ItemUseParameters.GetAlignmentPoint

(

)

GetCharGraphBindingName()

proto external string ItemUseParameters.GetCharGraphBindingName

(

)

GetCommandFloatArg()

proto external float ItemUseParameters.GetCommandFloatArg

(

)

GetCommandID()

proto external int ItemUseParameters.GetCommandID

(

)

GetCommandIntArg()

proto external int ItemUseParameters.GetCommandIntArg

(

)

GetEntity()

proto external IEntity ItemUseParameters.GetEntity

(

)

GetIntParam()

proto external int ItemUseParameters.GetIntParam

(

)

GetItemGraphEntryPoint()

proto external int ItemUseParameters.GetItemGraphEntryPoint

(

)

GetMaxAnimLength()

proto external float ItemUseParameters.GetMaxAnimLength

(

)

IsMainUserOfTheItem()

proto external bool ItemUseParameters.IsMainUserOfTheItem

(

)

Reset()

proto external void ItemUseParameters.Reset

(

)

SetAlignmentPoint()

proto external void ItemUseParameters.SetAlignmentPoint

(

PointInfo

pointWS

)

SetAllowMovementDuringAction()

proto external void ItemUseParameters.SetAllowMovementDuringAction

(

bool

allowed

)

SetCharGraphBindingName()

proto external void ItemUseParameters.SetCharGraphBindingName

(

string

charGraphBindingName

)

SetCommandFloatArg()

proto external void ItemUseParameters.SetCommandFloatArg

(

float

cmdFloatArg

)

SetCommandID()

proto external void ItemUseParameters.SetCommandID

(

int

cmdID

)

SetCommandIntArg()

proto external void ItemUseParameters.SetCommandIntArg

(

int

cmdIntArg

)

SetEntity()

proto external void ItemUseParameters.SetEntity

(

IEntity

entity

)

SetIntParam()

proto external void ItemUseParameters.SetIntParam

(

int

intParam

)

SetIsMainUserOfTheItem()

proto external void ItemUseParameters.SetIsMainUserOfTheItem

(

bool

isMainUser

)

SetItemGraphEntryPoint()

proto external void ItemUseParameters.SetItemGraphEntryPoint

(

string

itemGraphEntryPoint

)

SetKeepGadgetVisible()

proto external void ItemUseParameters.SetKeepGadgetVisible

(

bool

keepVisible

)

SetKeepInHandAfterSuccess()

proto external void ItemUseParameters.SetKeepInHandAfterSuccess

(

bool

keep

)

SetMaxAnimLength()

proto external void ItemUseParameters.SetMaxAnimLength

(

float

maxAnimLength

)

ShouldAllowMovementDuringAction()

proto external bool ItemUseParameters.ShouldAllowMovementDuringAction

(

)

ShouldKeepGadgetVisible()

proto external bool ItemUseParameters.ShouldKeepGadgetVisible

(

)

ShouldKeepInHandAfterSuccess()

proto external bool ItemUseParameters.ShouldKeepInHandAfterSuccess

(

)

---

The documentation for this interface was generated from the following file:

• Game/generated/Character/ItemUseParameters.c