stingray.IdString64 object reference

Description

A hashed string value.

NOTE: IdString64 objects are temporary. You can only use them in the frame in which they were generated. If you need to save a IdString64 across multiple frames, use a IdString64Box instead. For more information, see Object Lifetimes and Userdata Binding.

You can convert a string to an IdString64, but there is no way of converting the IdString64 back to a string. An IdString64 is a hashed value that can only be compared for equality.

Constructors and accessors

stingray.IdString64() stingray.IdString64.from_hex() stingray.IdString64Box() stingray.IdString64Box.unbox() stingray.Script.deserialize() stingray.Unit.id() stingray.Unit.set_material()

Other related reference items

	stingray.SaveSystem
	stingray.IdString64Box
	stingray.Script.serialize()

Related help topics

Release Notes > Stingray 1.8 Release Notes

Functions

equal ( a, b ) : boolean Indicates whether or not the two IdString64 values are equal.

Parameters

a :	stingray.IdString64	The first IdString64.
b :	stingray.IdString64	The second IdString64.

Returns

boolean

true the two IdString64 values are equal.

Note that you cannot compare the two values with ==, because == between two lightuserdata objects in lua only tests reference equality, not value equality.

from_hex ( s ) : stingray.IdString64 Returns an IdString64 representation of the hexadecimal value.

Parameters

s :

string

The hexadecimal string value to convert to an IdString64.

Returns

stingray.IdString64

An IdString64 representing the hexadecimal string value.

to_hex ( id ) : string Returns a hexadecimal representation of the IdString64.

Parameters

id :

stingray.IdString64

The id to convert to a hexadecimal string value.

Returns

string

A hexadecimal string representation of the IdString64.

to_string ( id ) : string Returns a string representation of the IdString64.

Parameters

id :

stingray.IdString64

The IdString64 to return as a string.

Returns

string

The string representation.

Note that this string representation is not the original string that was hashed (the pre-image). The pre-image of the hash cannot be obtained.