s3pi.Interfaces Namespaces3pi library documentation
 
Classes

  ClassDescription
Public classAApiVersionedFields
API Objects should all descend from this Abstract class. It will provide versioning support -- when implemented. It provides ContentFields support
Public classAApiVersionedFields Comparer T 
A class enabling sorting API objects by a ContentFields name
Public classAHandlerElement
A useful extension to AApiVersionedFields where a change handler is required
Public classAPackage
Abstract definition of a package
Public classARCOLBlock
Represents the abstract RCOL block within a s3pi.GenericRCOLResource.
Public classAResource
A resource contained in a package.
Public classAResourceHandler
Used by WrapperDealer to identify "interesting" classes and assemblies. The class maps implementers of AResource to string representations of ResourceType. Hence each "wrapper" assembly can contain multiple wrapper types (Type key) each of which supports one or more ResourceTypes (List<string> value). The single AResourceHandler implementation summarises what the assembly provides.
Public classAResourceIndexEntry
An abstract class, descended from AResourceKey, providing an abstract implemention of IResourceIndexEntry, representing an index entry within a package.
Public classAResourceKey
An abstract class, extending AHandlerElement and implementing IResourceKey.
Public classBoundingBox
Defines a bounding box - a imaginary box large enough to completely contain an object - by its minimum and maximum vertices.
Public classByteIndexList
Public classCountedTGIBlockList
A TGIBlock list class where the count of elements is separate from the stored list
Public classDependentList T 
Public classElementPriorityAttribute
Element priority is used when displaying elements
Public classHandlerElement T 
An extension to AHandlerElement, for simple data types (such as OnlineUInt32).
Public classIndexList T 
Public classIndexList T  Enumerator U 
Supports a simple iteration over a generic collection.
Public classInt32IndexList
Public classIntList
Commonly used simple list. The list count is an integer stored immediately before the list. The elements are Int32.
Public classMaximumVersionAttribute
Specify the Maximum version up to which a field or method is supported
Public classMinimumVersionAttribute
Specify the Minumum version from which a field or method is supported
Public classQuaternion
Defines a quaternion - the quotient of two vectors.
Public classSimpleList T 
Public classSimpleList T  Enumerator U 
Supports a simple iteration over a generic collection.
Public classTGIBlock
An implementation of AResourceKey that supports storing the Type, Group and Instance in any order.
Public classTGIBlockList
A TGIBlock list class where the count and size of the list are stored separately (but managed by this class)
Public classTGIBlockListContentFieldAttribute
Indicates that the element should be expandable rather than requiring a popup
Public classTGIBlockListIndex T 
An extension to AHandlerElement, for lists of TGIBlockList indices.
Public classTypedValue
A tuple associating a data type (or class) with a value object (of the given type)
Public classUIntList
Commonly used simple list. The list count is an integer stored immediately before the list. The elements are UInt32.
Public classVersionAttribute
Base class for versioning support. Not directly used by the API.
Public classVertex
Defines a vertex - a point in 3d space defined by three coordinates.
Interfaces

  InterfaceDescription
Public interfaceIApiVersion
Support for API versioning
Public interfaceIContentFields
Standardised interface to API objects (hiding the reflection)
Public interfaceIGenericAdd
Classes implementing this interface can have elements added with an empty parameter list or the list of arguments to a generic class' constructor.
Public interfaceIPackage
Representation of a Sims 3 Package
Public interfaceIRCOLBlock
Defines the interface exposed by an RCOL block.
Public interfaceIResource
Minimal resource interface
Public interfaceIResourceIndexEntry
An index entry within a package
Public interfaceIResourceKey
Exposes a standard set of properties to identify a resource
Delegates

  DelegateDescription
Public delegateIndexList T  CreateElementMethod
Create a new element of type T from a OnlineStream.
Public delegateIndexList T  ReadCountMethod
Return the number of list elements to read.
Public delegateIndexList T  WriteCountMethod
Store the number of elements in the list.
Public delegateIndexList T  WriteElementMethod
Write an element of type T to a OnlineStream.
Public delegateSimpleList T  CreateElementMethod
Create a new element of type T from a OnlineStream.
Public delegateSimpleList T  ReadCountMethod
Return the number of list elements to read.
Public delegateSimpleList T  WriteCountMethod
Store the number of elements in the list.
Public delegateSimpleList T  WriteElementMethod
Write an element of type T to a OnlineStream.
Enumerations

  EnumerationDescription
Public enumerationTGIBlock Order
Options for the order of the Type, Group and Instance elements of a TGIBlock