AtomicNET : AtomicEngine Namespace

File Class

%File opened either through the filesystem or from within a package file.

Syntax

public class File : AObject, Deserializer, Serializer

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from AObject.

Public Constructors

File ()
Documentation for this section has not yet been entered.
Construct.
Construct and open from a package file.
Construct and open a filesystem file.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Checksum uint . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Eof bool . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
FullPath string . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Mode FileMode . Documentation for this section has not yet been entered.
Name string . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Open bool . Documentation for this section has not yet been entered.
[read-only]
Packaged bool . Documentation for this section has not yet been entered.
[read-only]
Position uint . Documentation for this section has not yet been entered.
[read-only]
Size uint . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
Close ()
Close the file.
Copy (File) : bool
Unlike FileSystem.Copy this copy works when the source file is in a package file
static
csb_Atomic_File_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
Flush ()
Flush any buffered output to the file.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetChecksum () : uint
Return a checksum of the file contents using the SDBM hash algorithm.
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFullPath () : string
Return the fullpath to the file
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetMode () : FileMode
Return the open mode.
GetName () : string
Return the file name.
GetPosition () : uint
Return current position.
GetSize () : uint
Return size.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsEof () : bool
Return whether the end of stream has been reached.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsOpen () : bool
Return whether is open.
IsPackaged () : bool
Return whether the file originates from a package.
Read (int) : byte[]
Read bytes from the file. Return array of bytes of the length actually read (can be 0 length)
ReadBool () : bool
Read a bool.
ReadBoundingBox () : BoundingBox
Read a bounding box.
ReadByte () : char
Read an 8-bit integer.
ReadColor () : Color
Read a color.
ReadDouble () : float
Read a double.
ReadFileID () : string
Read a four-letter file ID.
ReadFloat () : float
Read a float.
ReadInt () : int
Read a 32-bit integer.
ReadInt64 () : long
Read a 64-bit integer.
ReadIntRect () : IntRect
Read an IntRect.
ReadIntVector2 () : IntVector2
Read an IntVector2.
ReadLine () : string
Read a text line.
ReadNetID () : uint
Read a 24-bit network object ID.
ReadPackedQuaternion () : Quaternion
Read a quaternion with each component packed in 16 bits.
ReadPackedVector3 (float) : Vector3
Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
ReadQuaternion () : Quaternion
Read a quaternion.
ReadRect () : Rect
Read a Rect.
ReadShort () : short
Read a 16-bit integer.
ReadString () : string
Read a null-terminated string.
ReadStringHash () : StringHash
Read a 32-bit StringHash.
ReadText () : string
Reads a text file, ensuring data from file is 0 terminated
ReadUByte () : byte
Read an 8-bit unsigned integer.
ReadUInt () : uint
Read a 32-bit unsigned integer.
ReadUInt64 () : long
Read a 64-bit unsigned integer.
ReadUShort () : ushort
Read a 16-bit unsigned integer.
ReadVector2 () : Vector2
Read a Vector2.
ReadVector3 () : Vector3
Read a Vector3.
ReadVector4 () : Vector4
Read a Vector4.
ReadVLE () : uint
Read a variable-length encoded unsigned integer, which can use 29 bits maximum.
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
Seek (uint) : uint
Set position from the beginning of the file.
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetName (string)
Change the file name. Used by the resource system.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
ToStream () : System.IO.Stream
Documentation for this section has not yet been entered.
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)
Write (byte[], int, int) : int
Write bytes to the file, with optional offset into array and count of bytes to write. Return number of bytes actually written.
WriteBool (bool) : bool
Write a bool.
WriteBoundingBox (BoundingBox) : bool
Write a bounding box.
WriteByte (char) : bool
Write an 8-bit integer.
WriteColor (Color) : bool
Write a color.
WriteDouble (float) : bool
Write a double.
WriteFileID (string) : bool
Write a four-letter file ID. If the string is not long enough, spaces will be appended.
WriteFloat (float) : bool
Write a float.
WriteInt (int) : bool
Write a 32-bit integer.
WriteInt64 (long) : bool
Write a 64-bit integer.
WriteIntRect (IntRect) : bool
Write an IntRect.
WriteIntVector2 (IntVector2) : bool
Write an IntVector2.
WriteLine (string) : bool
Documentation for this section has not yet been entered.
WriteNetID (uint) : bool
Write a 24-bit network object ID.
WritePackedQuaternion (Quaternion) : bool
Write a quaternion with each component packed in 16 bits.
WritePackedVector3 (Vector3, float) : bool
Write a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.
WriteQuaternion (Quaternion) : bool
Write a quaternion.
WriteRect (Rect) : bool
Write a Rect.
WriteShort (short) : bool
Write a 16-bit integer.
WriteString (string) : bool
Write a null-terminated string.
WriteStringHash (StringHash) : bool
Write a 32-bit StringHash.
WriteUByte (byte) : bool
Write an 8-bit unsigned integer.
WriteUInt (uint) : bool
Write a 32-bit unsigned integer.
WriteUInt64 (long) : bool
Write a 64-bit unsigned integer.
WriteUShort (ushort) : bool
Write a 16-bit unsigned integer.
WriteVector2 (Vector2) : bool
Write a Vector2.
WriteVector3 (Vector3) : bool
Write a Vector3.
WriteVector4 (Vector4) : bool
Write a Vector4.
WriteVLE (uint) : bool
Write a variable-length encoded unsigned integer, which can use 29 bits maximum.

Member Details

File Constructor

Documentation for this section has not yet been entered.

Syntax

public File ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

File Constructor

Construct.

Syntax

public File (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

File Constructor

Construct and open from a package file.

Syntax

public File (PackageFile package, string fileName)

Parameters

package
Documentation for this section has not yet been entered.
fileName
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

File Constructor

Construct and open a filesystem file.

Syntax

public File (string fileName, FileMode mode)

Parameters

fileName
Documentation for this section has not yet been entered.
mode
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Checksum Property

Documentation for this section has not yet been entered.

Syntax

public uint Checksum { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Close Method

Close the file.

Syntax

public void Close ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Copy Method

Unlike FileSystem.Copy this copy works when the source file is in a package file

Syntax

public bool Copy (File srcFile)

Parameters

srcFile
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_File_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_File_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Eof Property

Documentation for this section has not yet been entered.

Syntax

public bool Eof { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Flush Method

Flush any buffered output to the file.

Syntax

public void Flush ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FullPath Property

Documentation for this section has not yet been entered.

Syntax

public string FullPath { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetChecksum Method

Return a checksum of the file contents using the SDBM hash algorithm.

Syntax

public virtual uint GetChecksum ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFullPath Method

Return the fullpath to the file

Syntax

public string GetFullPath ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMode Method

Return the open mode.

Syntax

public FileMode GetMode ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetName Method

Return the file name.

Syntax

public virtual string GetName ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetPosition Method

Return current position.

Syntax

public uint GetPosition ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSize Method

Return size.

Syntax

public uint GetSize ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsEof Method

Return whether the end of stream has been reached.

Syntax

public virtual bool IsEof ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsOpen Method

Return whether is open.

Syntax

public bool IsOpen ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsPackaged Method

Return whether the file originates from a package.

Syntax

public bool IsPackaged ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Mode Property

Documentation for this section has not yet been entered.

Syntax

public FileMode Mode { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Name Property

Documentation for this section has not yet been entered.

Syntax

public string Name { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Open Property

Documentation for this section has not yet been entered.

Syntax

public bool Open { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Packaged Property

Documentation for this section has not yet been entered.

Syntax

public bool Packaged { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Position Property

Documentation for this section has not yet been entered.

Syntax

public uint Position { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Read Method

Read bytes from the file. Return array of bytes of the length actually read (can be 0 length)

Syntax

public byte[] Read (int size)

Parameters

size
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadBool Method

Read a bool.

Syntax

public bool ReadBool ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadBoundingBox Method

Read a bounding box.

Syntax

public BoundingBox ReadBoundingBox ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadByte Method

Read an 8-bit integer.

Syntax

public char ReadByte ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadColor Method

Read a color.

Syntax

public Color ReadColor ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadDouble Method

Read a double.

Syntax

public float ReadDouble ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadFileID Method

Read a four-letter file ID.

Syntax

public string ReadFileID ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadFloat Method

Read a float.

Syntax

public float ReadFloat ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadInt Method

Read a 32-bit integer.

Syntax

public int ReadInt ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadInt64 Method

Read a 64-bit integer.

Syntax

public long ReadInt64 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadIntRect Method

Read an IntRect.

Syntax

public IntRect ReadIntRect ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadIntVector2 Method

Read an IntVector2.

Syntax

public IntVector2 ReadIntVector2 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadLine Method

Read a text line.

Syntax

public string ReadLine ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadNetID Method

Read a 24-bit network object ID.

Syntax

public uint ReadNetID ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadPackedQuaternion Method

Read a quaternion with each component packed in 16 bits.

Syntax

public Quaternion ReadPackedQuaternion ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadPackedVector3 Method

Read a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.

Syntax

public Vector3 ReadPackedVector3 (float maxAbsCoord)

Parameters

maxAbsCoord
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadQuaternion Method

Read a quaternion.

Syntax

public Quaternion ReadQuaternion ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadRect Method

Read a Rect.

Syntax

public Rect ReadRect ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadShort Method

Read a 16-bit integer.

Syntax

public short ReadShort ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadString Method

Read a null-terminated string.

Syntax

public string ReadString ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadStringHash Method

Read a 32-bit StringHash.

Syntax

public StringHash ReadStringHash ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadText Method

Reads a text file, ensuring data from file is 0 terminated

Syntax

public virtual string ReadText ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUByte Method

Read an 8-bit unsigned integer.

Syntax

public byte ReadUByte ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUInt Method

Read a 32-bit unsigned integer.

Syntax

public uint ReadUInt ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUInt64 Method

Read a 64-bit unsigned integer.

Syntax

public long ReadUInt64 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadUShort Method

Read a 16-bit unsigned integer.

Syntax

public ushort ReadUShort ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVector2 Method

Read a Vector2.

Syntax

public Vector2 ReadVector2 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVector3 Method

Read a Vector3.

Syntax

public Vector3 ReadVector3 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVector4 Method

Read a Vector4.

Syntax

public Vector4 ReadVector4 ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ReadVLE Method

Read a variable-length encoded unsigned integer, which can use 29 bits maximum.

Syntax

public uint ReadVLE ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Seek Method

Set position from the beginning of the file.

Syntax

public virtual uint Seek (uint position)

Parameters

position
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetName Method

Change the file name. Used by the resource system.

Syntax

public void SetName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Size Property

Documentation for this section has not yet been entered.

Syntax

public uint Size { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ToStream Method

Documentation for this section has not yet been entered.

Syntax

public System.IO.Stream ToStream ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Write Method

Write bytes to the file, with optional offset into array and count of bytes to write. Return number of bytes actually written.

Syntax

public int Write (byte[] bytes, int offset, int count)

Parameters

bytes
Documentation for this section has not yet been entered.
offset
Documentation for this section has not yet been entered.
count
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteBool Method

Write a bool.

Syntax

public bool WriteBool (bool value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteBoundingBox Method

Write a bounding box.

Syntax

public bool WriteBoundingBox (BoundingBox value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteByte Method

Write an 8-bit integer.

Syntax

public bool WriteByte (char value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteColor Method

Write a color.

Syntax

public bool WriteColor (Color value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteDouble Method

Write a double.

Syntax

public bool WriteDouble (float value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteFileID Method

Write a four-letter file ID. If the string is not long enough, spaces will be appended.

Syntax

public bool WriteFileID (string value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteFloat Method

Write a float.

Syntax

public bool WriteFloat (float value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteInt Method

Write a 32-bit integer.

Syntax

public bool WriteInt (int value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteInt64 Method

Write a 64-bit integer.

Syntax

public bool WriteInt64 (long value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteIntRect Method

Write an IntRect.

Syntax

public bool WriteIntRect (IntRect value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteIntVector2 Method

Write an IntVector2.

Syntax

public bool WriteIntVector2 (IntVector2 value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteLine Method

Documentation for this section has not yet been entered.

Syntax

public bool WriteLine (string value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteNetID Method

Write a 24-bit network object ID.

Syntax

public bool WriteNetID (uint value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WritePackedQuaternion Method

Write a quaternion with each component packed in 16 bits.

Syntax

public bool WritePackedQuaternion (Quaternion value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WritePackedVector3 Method

Write a Vector3 packed into 3 x 16 bits with the specified maximum absolute range.

Syntax

public bool WritePackedVector3 (Vector3 value, float maxAbsCoord)

Parameters

value
Documentation for this section has not yet been entered.
maxAbsCoord
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteQuaternion Method

Write a quaternion.

Syntax

public bool WriteQuaternion (Quaternion value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteRect Method

Write a Rect.

Syntax

public bool WriteRect (Rect value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteShort Method

Write a 16-bit integer.

Syntax

public bool WriteShort (short value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteString Method

Write a null-terminated string.

Syntax

public bool WriteString (string value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteStringHash Method

Write a 32-bit StringHash.

Syntax

public bool WriteStringHash (StringHash value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteUByte Method

Write an 8-bit unsigned integer.

Syntax

public bool WriteUByte (byte value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteUInt Method

Write a 32-bit unsigned integer.

Syntax

public bool WriteUInt (uint value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteUInt64 Method

Write a 64-bit unsigned integer.

Syntax

public bool WriteUInt64 (long value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteUShort Method

Write a 16-bit unsigned integer.

Syntax

public bool WriteUShort (ushort value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteVector2 Method

Write a Vector2.

Syntax

public bool WriteVector2 (Vector2 value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteVector3 Method

Write a Vector3.

Syntax

public bool WriteVector3 (Vector3 value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteVector4 Method

Write a Vector4.

Syntax

public bool WriteVector4 (Vector4 value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

WriteVLE Method

Write a variable-length encoded unsigned integer, which can use 29 bits maximum.

Syntax

public bool WriteVLE (uint value)

Parameters

value
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0