C# Class Zyrenth.Zora.RingSecret

Represents a secret used to transfer rings between games in the Zelda Oracle series.

Inheritance: Secret

Show file Open project: kabili207/zora-sharp

Public Methods

Method	Description
Equals ( object obj ) : bool	Determines whether the specified System.Object, is equal to this instance.
GetHashCode ( ) : int	Returns a hash code for this instance.
Load ( GameInfo info ) : void	Loads in data from the specified game info
Load ( byte secret ) : void	Loads in data from the raw secret data provided
RingSecret ( ) : System	Initializes a new instance of the RingSecret class.
RingSecret ( GameInfo info ) : System	Initializes a new instance of the RingSecret class from the specified game info.
RingSecret ( short gameId, Rings rings ) : System	Initializes a new instance of the RingSecret class with the specified gameId and rings.
ToBytes ( ) : byte[]	Gets the raw secret data as a byte array
UpdateGameInfo ( GameInfo info, bool appendRings ) : void	Updates the GameInfo.Rings property with the rings in this secret

Determines whether the specified System.Object, is equal to this instance.

public Equals ( object obj ) : bool
obj	object	The to compare with this instance.
return	bool

Returns a hash code for this instance.

public GetHashCode ( ) : int
return	int

Loads in data from the specified game info

public Load ( GameInfo info ) : void
info	GameInfo	The game info
return	void

Loads in data from the raw secret data provided

Initializes a new instance of the RingSecret class.

public RingSecret ( ) : System
return	System

Initializes a new instance of the RingSecret class from the specified game info.

public RingSecret ( GameInfo info ) : System
info	GameInfo	The game information.
return	System

Initializes a new instance of the RingSecret class with the specified gameId and rings.

public RingSecret ( short gameId, Rings rings ) : System
gameId	short	The game identifier.
rings	Rings	The rings.
return	System

Gets the raw secret data as a byte array

public ToBytes ( ) : byte[]
return	byte[]

Updates the GameInfo.Rings property with the rings in this secret

/// The Game IDs of the secret and game info do not match. ///

public UpdateGameInfo ( GameInfo info, bool appendRings ) : void
info	GameInfo	The information.
appendRings	bool	/// If true, this will add the rings contained in the secret to the /// existings Rings. If false, it will overwrite them. ///
return	void