csLoadResult Struct Reference (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Attributes
csLoadResult Struct Reference
Loading & Saving support

Return structure for the iLoader::Load() routines. More...

`#include <imap/loader.h>`

List of all members.

## Public Attributes
csRef< iBase > | result
| The object that was loaded.
bool | success
| True if the object was loaded successfully.

## Detailed Description

Return structure for the iLoader::Load() routines.

Definition at line 135 of file loader.h.

## Member Data Documentation

csRef<iBase> csLoadResult::result

The object that was loaded.

Depending on the file you load this can be anything like:

- 'world' file: in that case 'result' will be set to the engine.
- 'library' file: 'result' will be 0.
- 'meshfact' file: 'result' will be the mesh factory wrapper.
- 'meshobj' file: 'result' will be the mesh wrapper.
- 'meshref' file: 'result' will be the mesh wrapper.
- 'portals' file: 'result' will be the portal's mesh wrapper.
- 'light' file: 'result' will be the light. Note! In case of a light call DecRef() after you added it to a sector. Note! Use scfQueryInterface on 'result' to detect what type was loaded.

Definition at line 153 of file loader.h.

bool csLoadResult::success

True if the object was loaded successfully.

Definition at line 138 of file loader.h.

The documentation for this struct was generated from the following file:

- imap/loader.h