Ice python

From WiCWiki

Revision as of 15:53, 21 November 2007 by Tabu (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search

Contents

Ice

An Ice object wrapped for use from python.


Members

Name

Type
int
Description
The hashed name of the Ice.


Type

Type
int
Description
The hashed type name of the Ice.



Methods

IsNamed

Syntax
import wic
wic.common.Ice.IsNamed( aName )
Description
Returns True it the name of this Ice matches aName.
Exceptions
TypeError - aName isn't a string
See also
#IsType



IsType

Syntax
import wic
wic.common.Ice.IsType( aType )
Description
Returns True it the type of the Ice matches aType.
Exceptions
TypeError - aType isn't a string.
See also
#IsName



GetName

Syntax
import wic
wic.common.Ice.GetName()
Description
Returns the hashed name of the Ice.
Exceptions
-
See also
#GetType



GetType

Syntax
import wic
wic.common.Ice.GetType()
Description
Returns the hashed type name of the Ice.
Exceptions
-
See also
#GetName



GetValue

Syntax
import wic
wic.common.Ice.GetValue()
Description
Returns the string value of the Ice.
Exceptions
-
See also
#GetValueInt
#GetValueFloat
#GetValueBool
#GetValuePosition



GetValueInt

Syntax
import wic
wic.common.Ice.GetValueInt()
Description
Returns the int value of the Ice.
Exceptions
-
See also
#GetValue
#GetValueFloat
#GetValueBool
#GetValuePosition



GetValueFloat

Syntax
import wic
wic.common.Ice.GetValueFloat()
Description
Returns the float value of the Ice.
Exceptions
-
See also
-



GetValueBool

Syntax
import wic
wic.common.Ice.GetValueBool()
Description
Returns the bool value of the Ice.
Exceptions
-
See also
#GetValueInt
#GetValueFloat
#GetValue
#GetValuePosition



GetValuePosition

Syntax
import wic
wic.common.Ice.GetValuePosition()
Description
Returns the Vector3 value of the Ice.
Exceptions
-
See also
#GetValueInt
#GetValueFloat
#GetValueBool
#GetValue



GetMember

Syntax
import wic
wic.common.Ice.GetMember( aMemberName )
Description
Retrieves a child member named aMemberName from the Ice.
Exceptions
UnknownIceMemberException - The Ice have no member matching aMemberName
TypeError - aMemberName is not a string.
See also
#GetMemberAtIndex
#GetMemberHashed
#GetNumMembers



GetMemberAtIndex

Syntax
import wic
wic.common.Ice.GetMemberAtIndex( anIndex )
Description
Retrieves the Ice member at ths index given in anIndex.
Exceptions
UnknownIceMemberException - The Ice have no member matching anIndex.
TypeError - anIndex is not an int.
See also
#GetMember
#GetMemberHashed
#GetNumMembers



GetMemberHashed

Syntax
import wic
wic.common.Ice.GetMemberHashed( aNameHashed )
Description
Retrieves the Ice member named aNameHash.
Exceptions
UnknownIceMemberException - The Ice have no member matching aNameHash.
TypeError - aNameHash is not an int.
See also
#GetMember
#GetMemberAtIndex
#GetNumMembers



GetNumMembers

Syntax
import wic
wic.common.Ice.GetNumMembers()
Description
Returns the number of child members of the Ice.
Exceptions
-
See also
-



GetMemberValue

Syntax
import wic
wic.common.Ice.GetMemberValue( aMemberName )
Description
Retrieves the string value of the member named aMemberName.
Exceptions
UnknownIceMemberException - No member with the name aMemberName was found.
TypeError - aMemberName isn't a string.
See also
#GetMemberValueInt
#GetMemberValueFloat
#GetMemberValueBool



GetMemberValueInt

Syntax
import wic
wic.common.Ice.GetMemberValueInt( aMemberName )
Description
Retrieves the int value of the member named aMemberName.
Exceptions
UnknownIceMemberException - No member with the name aMemberName was found.
TypeError - aMemberName isn't a string.
See also
-



GetMemberValueFloat

Syntax
import wic
wic.common.Ice.GetMemberValueFloat( aMemberName )
Description
Retrieves the float value of the member named aMemberName.
Exceptions
UnknownIceMemberException - No member with the name aMemberName was found.
TypeError - aMemberName isn't a string.
See also
#GetMemberValue
#GetMemberValueInt
#GetMemberValueBool



GetMemberValueBool

Syntax
import wic
wic.common.Ice.GetMemberValueBool( aMemberName )
Description
Retrieves the bool value of the member named aMemberName.
Exceptions
UnknownIceMemberException - No member with the name aMemberName was found.
TypeError - aMemberName isn't a string.
See also
#GetMemberValue
#GetMemberValueInt
#GetMemberValueFloat


Personal tools
User Created Content