Function cleo_redux_sdk::to_rust_string
source · Examples found in repository?
lib.rs (line 250)
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
pub fn get_string_param(ctx: Context) -> String {
let mut buf = [0i8; SDK_STRING_MAX_LEN];
unsafe { GetStringParam(ctx, buf.as_mut_ptr(), SDK_STRING_MAX_LEN as _) };
to_rust_string(buf.as_ptr())
}
/// Writes the string value
///
/// since v1
pub fn set_string_param(ctx: Context, value: String) {
unsafe { SetStringParam(ctx, sz!(value)) };
}
/// Reads an integer argument (32 or 64 bit depending on target platform)
///
/// since v1
pub fn get_int_param(ctx: Context) -> isize {
unsafe { GetIntParam(ctx) }
}
/// Writes the integer value (32 or 64 bit depending on target platform)
///
/// since v1
pub fn set_int_param(ctx: Context, value: isize) {
unsafe { SetIntParam(ctx, value) };
}
/// Returns the absolute path to the CLEO directory
///
/// since v1
///
/// deprecated: use get_directory_path()
pub fn get_cleo_folder() -> std::path::PathBuf {
get_directory_path(Directory::CLEO)
}
/// Returns the absolute path to the current working directory (normally the game directory)
///
/// since v1
pub fn get_cwd() -> std::path::PathBuf {
let mut buf = [0i8; 256];
unsafe { GetCwd(buf.as_mut_ptr()) };
std::path::Path::new(&to_rust_string(buf.as_ptr())).into()
}
/// Resolves a path to the absolute path
/// - absolute path gets resolved as is
/// - path starting with "CLEO/" gets resolved relative to the CLEO directory
/// * either {game}\CLEO or
/// * {user}\AppData\Roaming\CLEO Redux\CLEO
/// - all other paths get resolved relative to the cwd (game directory)
///
/// since v1
pub fn resolve_path(path: &str) -> std::path::PathBuf {
let mut dest = [0i8; 256];
unsafe { ResolvePath(sz!(path), dest.as_mut_ptr()) };
std::path::Path::new(&to_rust_string(dest.as_ptr())).into()
}
/// Reads a floating-point argument
///
/// since v1
pub fn get_float_param(ctx: Context) -> f32 {
unsafe { GetFloatParam(ctx) }
}
/// Writes the floating-point value
///
/// since v1
pub fn set_float_param(ctx: Context, value: f32) {
unsafe { SetFloatParam(ctx, value) };
}
/// Sets the status of the current condition
///
/// since v1
pub fn update_compare_flag(ctx: Context, value: bool) {
unsafe { UpdateCompareFlag(ctx, value) }
}
/// Returns a host name
/// The default value matches https://re.cleo.li/docs/en/api.html#host
/// Can be changed with SetHostName
///
/// since v2
pub fn get_host_name() -> String {
let mut buf = [0i8; SDK_STRING_MAX_LEN];
unsafe { GetHostName(buf.as_mut_ptr(), SDK_STRING_MAX_LEN as _) };
to_rust_string(buf.as_ptr())
}
/// Sets the new host name (accessible in scripts via the HOST constant)
///
/// since v2
pub fn set_host_name(value: String) {
unsafe { SetHostName(sz!(value)) };
}
/// Initializes or reloads CLEO runtime
///
/// since v2
pub fn runtime_init() {
unsafe { RuntimeInit() }
}
/// Iterates the main loop
///
/// since v2
pub fn runtime_next_tick(current_time: u32, time_step: i32) {
unsafe { RuntimeNextTick(current_time, time_step) }
}
pub fn to_rust_string(addr: *const i8) -> String {
unsafe {
std::ffi::CStr::from_ptr(addr)
.to_owned()
.into_string()
.unwrap_or_default()
}
}
/// Registers a new loader for files matching a glob pattern
///
/// since v3
#[allow(dead_code)]
pub fn register_loader(glob: &str, cb: CustomLoader) {
unsafe {
RegisterLoader(sz!(glob), cb);
}
}
/// Allocates a memory chunk with size in bytes. Memory is guaranteed to be zero initialized
///
/// since v3
#[allow(dead_code)]
pub fn alloc_mem(size: usize) -> *mut c_void {
unsafe { AllocMem(size) }
}
/// Frees up the memory chunk allocated with AllocMem
///
/// since v3
#[allow(dead_code)]
pub fn free_mem(ptr: *mut c_void) {
unsafe { FreeMem(ptr) }
}
/// Registers a new callback invoked on each main loop iteration (before scripts are executed)
///
/// since v4
#[allow(dead_code)]
pub fn on_before_scripts(cb: OnTickCallback) {
unsafe {
OnBeforeScripts(cb);
}
}
/// Registers a new callback invoked on each main loop iteration (after scripts are executed)
///
/// since v4
#[allow(dead_code)]
pub fn on_after_scripts(cb: OnTickCallback) {
unsafe {
OnAfterScripts(cb);
}
}
/// Registers a new callback invoked on each runtime init event (new game, saved game load, or SDK's RuntimeInit)
///
/// since v4
#[allow(dead_code)]
pub fn on_runtime_init(cb: OnRuntimeInitCallback) {
unsafe {
OnRuntimeInit(cb);
}
}
/// Registers a new callback invoked on a ShowTextBox function call. Providing a callback shadows built-in ShowTextBox implementation.
///
/// since v5
#[allow(dead_code)]
pub fn on_show_text_box(cb: OnShowTextBoxCallback) {
unsafe {
OnShowTextBox(cb);
}
}
/// Returns the absolute path to the CLEO root directory or one of its sub-directories
///
/// since v6
#[allow(dead_code)]
pub fn get_directory_path(dir: Directory) -> std::path::PathBuf {
let mut buf = [0i8; 256];
unsafe { GetDirectoryPath(dir, buf.as_mut_ptr()) };
std::path::Path::new(&to_rust_string(buf.as_ptr())).into()
}
/// Returns CLEO Redux version as a string
///
/// since v6
#[allow(dead_code)]
pub fn get_cleo_version() -> String {
let mut buf = [0i8; 256];
unsafe { GetCLEOVersion(buf.as_mut_ptr()) };
to_rust_string(buf.as_ptr())
}