namigator 0.1.0

Rust bindings for the namigator pathfinding library for World of Warcraft.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use crate::error::{error_code_to_error, NamigatorError};
use crate::util::path_to_cstr;
use namigator_sys::{
    mapbuild_build_bvh, mapbuild_build_map, mapbuild_bvh_files_exist, mapbuild_map_files_exist,
    SUCCESS,
};
use std::ffi::{c_uint, CString};
use std::path::Path;

/// Build the game objects as a Bounded Volume Hierachy (BVH) and returns the amount of objects built.
///
/// `data_path` must point to the `Data` directory of the client that contains the `MPQ` files..
///
/// `output_path` points to where the generated files will be placed. If the directory does not exist it will be created.
///
/// `threads` is the amount of threads that will be used.
pub fn build_bvh(
    data_path: impl AsRef<Path>,
    output_path: impl AsRef<Path>,
    threads: u32,
) -> Result<u32, NamigatorError> {
    fn inner(data_path: &Path, output_path: &Path, threads: u32) -> Result<u32, NamigatorError> {
        let data_path = path_to_cstr(data_path)?;

        let output_path = path_to_cstr(output_path)?;

        let mut amount_of_bvhs_built: c_uint = 0;

        let result = unsafe {
            mapbuild_build_bvh(
                data_path.as_ptr(),
                output_path.as_ptr(),
                threads,
                &mut amount_of_bvhs_built as *mut c_uint,
            )
        };

        if result == SUCCESS {
            Ok(amount_of_bvhs_built)
        } else {
            Err(error_code_to_error(result))
        }
    }

    inner(data_path.as_ref(), output_path.as_ref(), threads)
}

/// Build the map files.
///
/// `data_path` must point to the `Data` directory of the client that contains the `MPQ` files..
///
/// `output_path` points to where the generated files will be placed. If the directory does not exist it will be created.
///
/// `map_name` TODO
///
/// `gameobject_csv` TODO
///
/// `threads` is the amount of threads that will be used.
pub fn build_map(
    data_path: impl AsRef<Path>,
    output_path: impl AsRef<Path>,
    map_name: &str,
    gameobject_csv: impl AsRef<Path>,
    threads: u32,
) -> Result<(), NamigatorError> {
    fn inner(
        data_path: &Path,
        output_path: &Path,
        map_name: &str,
        gameobject_csv: &Path,
        threads: u32,
    ) -> Result<(), NamigatorError> {
        let data_path = path_to_cstr(data_path)?;
        let output_path = path_to_cstr(output_path)?;
        let gameobject_csv = path_to_cstr(gameobject_csv)?;
        let map_name = CString::new(map_name)?;

        let result = unsafe {
            mapbuild_build_map(
                data_path.as_ptr(),
                output_path.as_ptr(),
                map_name.as_ptr(),
                gameobject_csv.as_ptr(),
                threads,
            )
        };

        if result == SUCCESS {
            return Ok(());
        }

        Err(error_code_to_error(result))
    }

    inner(
        data_path.as_ref(),
        output_path.as_ref(),
        map_name,
        gameobject_csv.as_ref(),
        threads,
    )
}

pub fn map_files_exist(
    output_path: impl AsRef<Path>,
    map_name: &str,
) -> Result<bool, NamigatorError> {
    fn inner(output_path: &Path, map_name: &str) -> Result<bool, NamigatorError> {
        let output_path = path_to_cstr(output_path)?;
        let map_name = CString::new(map_name)?;
        let mut exists: u8 = 0;
        let result = unsafe {
            mapbuild_map_files_exist(
                output_path.as_ptr(),
                map_name.as_ptr(),
                &mut exists as *mut u8,
            )
        };

        if result == SUCCESS {
            Ok(exists != 0)
        } else {
            Err(error_code_to_error(result))
        }
    }
    inner(output_path.as_ref(), map_name)
}

pub fn bvh_files_exist(output_path: impl AsRef<Path>) -> Result<bool, NamigatorError> {
    fn inner(output_path: &Path) -> Result<bool, NamigatorError> {
        let output_path = path_to_cstr(output_path)?;
        let mut exists: u8 = 0;
        let result =
            unsafe { mapbuild_bvh_files_exist(output_path.as_ptr(), &mut exists as *mut u8) };

        if result == SUCCESS {
            Ok(exists != 0)
        } else {
            Err(error_code_to_error(result))
        }
    }
    inner(output_path.as_ref())
}