mirror of
https://github.com/coop-deluxe/sm64coopdx.git
synced 2025-10-30 08:01:01 +00:00
d9f5869fcd
Some checks failed
Build coop / build-linux (push) Has been cancelled
Build coop / build-steamos (push) Has been cancelled
Build coop / build-windows-opengl (push) Has been cancelled
Build coop / build-windows-directx (push) Has been cancelled
Build coop / build-macos-arm (push) Has been cancelled
Build coop / build-macos-intel (push) Has been cancelled
160 lines
2.9 KiB
Markdown
160 lines
2.9 KiB
Markdown
## [:rewind: Lua Functions](functions.md)
|
|
|
|
---
|
|
|
|
[< prev](functions-6.md) | [1](functions.md) | [2](functions-2.md) | [3](functions-3.md) | [4](functions-4.md) | [5](functions-5.md) | [6](functions-6.md) | 7]
|
|
|
|
|
|
---
|
|
# functions from surface_load.h
|
|
|
|
<br />
|
|
|
|
|
|
## [load_object_collision_model](#load_object_collision_model)
|
|
|
|
### Description
|
|
Loads the object's collision data into dynamic collision. You must run this every frame in your object's behavior loop for it to have collision
|
|
|
|
### Lua Example
|
|
`load_object_collision_model()`
|
|
|
|
### Parameters
|
|
- None
|
|
|
|
### Returns
|
|
- None
|
|
|
|
### C Prototype
|
|
`void load_object_collision_model(void);`
|
|
|
|
[:arrow_up_small:](#)
|
|
|
|
<br />
|
|
|
|
## [obj_get_surface_from_index](#obj_get_surface_from_index)
|
|
|
|
### Description
|
|
Gets a surface corresponding to `index` from the surface pool buffer
|
|
|
|
### Lua Example
|
|
`local SurfaceValue = obj_get_surface_from_index(o, index)`
|
|
|
|
### Parameters
|
|
| Field | Type |
|
|
| ----- | ---- |
|
|
| o | [Object](structs.md#Object) |
|
|
| index | `integer` |
|
|
|
|
### Returns
|
|
[Surface](structs.md#Surface)
|
|
|
|
### C Prototype
|
|
`struct Surface *obj_get_surface_from_index(struct Object *o, u32 index);`
|
|
|
|
[:arrow_up_small:](#)
|
|
|
|
<br />
|
|
|
|
## [surface_has_force](#surface_has_force)
|
|
|
|
### Description
|
|
Checks if a surface has force
|
|
|
|
### Lua Example
|
|
`local booleanValue = surface_has_force(surfaceType)`
|
|
|
|
### Parameters
|
|
| Field | Type |
|
|
| ----- | ---- |
|
|
| surfaceType | `integer` |
|
|
|
|
### Returns
|
|
- `boolean`
|
|
|
|
### C Prototype
|
|
`bool surface_has_force(s16 surfaceType);`
|
|
|
|
[:arrow_up_small:](#)
|
|
|
|
<br />
|
|
|
|
---
|
|
# functions from sync_object.h
|
|
|
|
<br />
|
|
|
|
|
|
## [sync_object_get_object](#sync_object_get_object)
|
|
|
|
### Description
|
|
Retrieves an object from a sync ID
|
|
|
|
### Lua Example
|
|
`local ObjectValue = sync_object_get_object(syncId)`
|
|
|
|
### Parameters
|
|
| Field | Type |
|
|
| ----- | ---- |
|
|
| syncId | `integer` |
|
|
|
|
### Returns
|
|
[Object](structs.md#Object)
|
|
|
|
### C Prototype
|
|
`struct Object* sync_object_get_object(u32 syncId);`
|
|
|
|
[:arrow_up_small:](#)
|
|
|
|
<br />
|
|
|
|
## [sync_object_is_initialized](#sync_object_is_initialized)
|
|
|
|
### Description
|
|
Checks if a sync object is initialized using a `syncId`
|
|
|
|
### Lua Example
|
|
`local booleanValue = sync_object_is_initialized(syncId)`
|
|
|
|
### Parameters
|
|
| Field | Type |
|
|
| ----- | ---- |
|
|
| syncId | `integer` |
|
|
|
|
### Returns
|
|
- `boolean`
|
|
|
|
### C Prototype
|
|
`bool sync_object_is_initialized(u32 syncId);`
|
|
|
|
[:arrow_up_small:](#)
|
|
|
|
<br />
|
|
|
|
## [sync_object_is_owned_locally](#sync_object_is_owned_locally)
|
|
|
|
### Description
|
|
Checks if a sync object is owned locally using a `syncId`
|
|
|
|
### Lua Example
|
|
`local booleanValue = sync_object_is_owned_locally(syncId)`
|
|
|
|
### Parameters
|
|
| Field | Type |
|
|
| ----- | ---- |
|
|
| syncId | `integer` |
|
|
|
|
### Returns
|
|
- `boolean`
|
|
|
|
### C Prototype
|
|
`bool sync_object_is_owned_locally(u32 syncId);`
|
|
|
|
[:arrow_up_small:](#)
|
|
|
|
<br />
|
|
|
|
---
|
|
|
|
[< prev](functions-6.md) | [1](functions.md) | [2](functions-2.md) | [3](functions-3.md) | [4](functions-4.md) | [5](functions-5.md) | [6](functions-6.md) | 7]
|
|
|