ObscuredVector3Int Struct Reference

Inherits IEquatable< ObscuredVector3Int >, IEquatable< Vector3Int >, and IObscuredType.

Classes
struct	RawEncryptedVector3Int

Public Member Functions
	ObscuredVector3Int (int x, int y, int z)
RawEncryptedVector3Int	GetEncrypted (out int key)
void	SetEncrypted (RawEncryptedVector3Int encrypted, int key)
Vector3Int	GetDecrypted ()
void	RandomizeCryptoKey ()

Static Public Member Functions
static RawEncryptedVector3Int	Encrypt (Vector3Int value, int key)
static RawEncryptedVector3Int	Encrypt (int x, int y, int z, int key)
static Vector3Int	Decrypt (RawEncryptedVector3Int value, int key)
static ObscuredVector3Int	FromEncrypted (RawEncryptedVector3Int encrypted, int key)
static int	GenerateKey ()

Detailed Description

Use it instead of regular Vector3Int for any cheating-sensitive variables.

WARNING: Doesn't mimic regular type API, thus should be used with extra caution. Cast it to regular, not obscured type to work with regular APIs.
Regular type is faster and memory wiser comparing to the obscured one!
Feel free to use regular types for all short-term operations and calculations while keeping obscured type only at the long-term declaration (i.e. class field).

Constructor & Destructor Documentation

ObscuredVector3Int()

ObscuredVector3Int ( int  x, int  y, int  z  )

inline

Mimics constructor of regular Vector3Int.

Parameters

x	X component of the vector
y	Y component of the vector
z	Z component of the vector

Member Function Documentation

Encrypt() [1/2]

static RawEncryptedVector3Int Encrypt ( Vector3Int  value, int  key  )

inlinestatic

Encrypts passed value using passed key.

Key can be generated automatically using GenerateKey().

See also

Decrypt(), GenerateKey()

Encrypt() [2/2]

static RawEncryptedVector3Int Encrypt ( int  x, int  y, int  z, int  key  )

inlinestatic

Encrypts passed components using passed key.

Key can be generated automatically using GenerateKey().

See also

Decrypt(), GenerateKey()

Decrypt()

static Vector3Int Decrypt ( RawEncryptedVector3Int  value, int  key  )

inlinestatic

Decrypts passed value you got from Encrypt() using same key.

See also

Encrypt()

FromEncrypted()

static ObscuredVector3Int FromEncrypted ( RawEncryptedVector3Int  encrypted, int  key  )

inlinestatic

Creates and fills obscured variable with raw encrypted value previously got from GetEncrypted().

Literally does same job as SetEncrypted() but makes new instance instead of filling existing one, making it easier to initialize new variables from saved encrypted values.

Parameters

encrypted	Raw encrypted value you got from GetEncrypted().
key	Encryption key you've got from GetEncrypted().

Returns

New obscured variable initialized from specified encrypted value.

See also

GetEncrypted(), SetEncrypted()

GenerateKey()

static int GenerateKey ( )

inlinestatic

Generates random key. Used internally and can be used to generate key for manual Encrypt() calls.

Returns

Key suitable for manual Encrypt() calls.

GetEncrypted()

RawEncryptedVector3Int GetEncrypted ( out int  key )

inline

Allows to pick current obscured value as is.

Parameters

key	Encryption key needed to decrypt returned value.

Returns

Encrypted value as is.

Use it in conjunction with SetEncrypted().
Useful for saving data in obscured state.

See also

FromEncrypted(), SetEncrypted()

SetEncrypted()

void SetEncrypted ( RawEncryptedVector3Int  encrypted, int  key  )

inline

Allows to explicitly set current obscured value. Crypto key should be same as when encrypted value was got with GetEncrypted().

Use it in conjunction with GetEncrypted().
Useful for loading data stored in obscured state.

See also

FromEncrypted()

GetDecrypted()

Vector3Int GetDecrypted ( )

inline

Alternative to the type cast, use if you wish to get decrypted value but can't or don't want to use cast to the regular type.

Returns

Decrypted value.

RandomizeCryptoKey()

void RandomizeCryptoKey ( )

inline

Allows to change current crypto key to the new random value and re-encrypt variable using it. Use it for extra protection against 'unknown value' search. Just call it sometimes when your variable doesn't change to fool the cheater.

Implements IObscuredType.