Yanzari's-Modder/SRB2Python/Documentation

This is a documentation of all the things you can edit with python code.

Currently, all you can edit is the player object.

Contents 1 Functions 1.1 get_player() 1.2 set_player() 2 Variables 2.1 Player Object 2.1.1 playerstate 2.1.2 health 2.1.3 currentweapon 2.1.4 ringweapons 2.1.5 tossstrength 2.1.6 powers 2.1.7 pflags 2.1.8 skincolor 2.1.9 skin 2.1.10 score 2.1.11 dashspeed 2.1.12 runspeed 2.1.13 thrustfactor 2.1.14 accelstart 2.1.15 acceleration 2.1.16 charability 2.1.17 charability2 2.1.18 charflags 2.1.19 thokitem 2.1.20 spinitem 2.1.21 actionspd 2.1.22 mindash 2.1.23 maxdash 2.1.24 jumpfactor 2.1.25 starttranscolor 2.1.26 prefcolor 2.1.27 lives 2.1.28 continues 2.1.29 xtralife 2.1.30 speed 2.1.31 jumping 2.1.32 secondjump 2.1.33 fly1 2.1.34 scoreadd 2.1.35 glidetime 2.1.36 climbing 2.1.37 deadtimer 2.1.38 splish 2.1.39 exiting 2.1.40 blackow 2.1.41 homing 2.1.42 Conveyor Belt Movement 2.1.42.1 cmomx 2.1.42.2 cmomy 2.1.42.3 rmomx 2.1.42.4 rmomy 2.1.43 Race Mode Stuff 2.1.43.1 numboxes 2.1.43.2 totalring 2.1.43.3 realtime 2.1.43.4 racescore 2.1.43.5 laps 2.1.44 Tag Mode Stuff 2.1.44.1 tagzone 2.1.44.2 taglag 2.1.45 CTF Mode Stuff 2.1.45.1 ctfteam 2.1.45.2 gotflag 2.1.46 dbginfo 2.1.47 = emeraldhunt 2.1.48 weapondelay 2.1.49 tossdelay 2.1.50 shielddelay 2.1.51 taunttimer 2.1.52 Starpost information 2.1.52.1 starpostx 2.1.52.2 long starposty 2.1.52.3 long starpostz 2.1.52.4 long starpostnum 2.1.52.5 starposttime 2.1.52.6 starpostangle 2.1.52.7 starpostbit 2.1.53 NiGHTS Stuff 2.1.53.1 angle_pos 2.1.53.2 old_angle_pos 2.1.53.3 axis1 2.1.53.4 axis2 2.1.53.5 bumpertime 2.1.53.6 flyangle 2.1.53.7 drilltimer 2.1.53.8 linkcount 2.1.53.9 linktimer 2.1.53.10 anotherflyangle 2.1.53.11 nightstime 2.1.53.12 drillmeter 2.1.53.13 drilldelay 2.1.53.14 bonustime 2.1.53.15 capsule 2.1.53.16 mare 2.1.54 lastsidehit 2.1.55 lastlinehit 2.1.56 losscount 2.1.57 currentthing 2.1.58 onconveyor 2.1.59 awayviewmobj 2.1.60 awayviewtics 2.1.61 spectator 2.1.62 jointime

Functions

get_player()

Usage: srb2.get_player(node)

Example:

playerobj = srb2.get_player(0)

This gets the player with the node 0, which is you in single player mode.

set_player()

Usage: srb2.set_player(node, playerobject)

Example:

playerobj srb2.get_player(0)

playerobj.lives -= 1

set_player(0, playerobj)

• Here, we use get_player() to get a player object.
• We set the lives of the player to 1 less than what they already were, because we're evil.
• We then use set_player() to apply the changes.

Variables

Player Object

health

The player's ring count. When changing this, player.mo.health must also be updated.

Example: See SRB2PythonPageRemake#Example

lives

The number of lives the current player has.

Example:

playerobj srb2.get_player(0)

playerobj.lives -= 1

set_player(0, playerobj)

• Here, we use get_player() to get a player object.
• We set the lives of the player to 1 less than what they already were, because we're evil.
• We then use set_player() to apply the changes.

continues

The number of continues the player has collected.

Example:

playerobj = srb2.get_player(0)
playerobj.continues += 1
srb2.set_player(0,playerobj)

• We get the player object for node 0
• We give the player an extra continue
• We push our modified data back into the game.

speed

Player's speed (distance formula of MOMX and MOMY values)

fly1

Tails flying

scoreadd

Used for multiple enemy attack bonus

glidetime

Glide counter for thrust

climbing

Are you climbing?

deadtimer

End game if game over lasts too long

splish

Don't make splish repeat tons

exiting

Exitlevel timer

homing

Are you homing?

Conveyor Belt Movement

cmomx

Conveyor momx

cmomy

Conveyor momy

rmomx

"Real" momx (momx - cmomx)

rmomy

"Real" momy (momy - cmomy)

Race Mode Stuff

numboxes

Number of item boxes obtained for Race Mode

totalring

Total number of rings obtained for Race Mode

realtime

integer replacement for leveltime

racescore

Total of won categories

laps

Number of laps (optional)

Tag Mode Stuff

tagzone

Tag Zone timer

taglag

Don't go back in the tag zone too early

CTF Mode Stuff

ctfteam

0 - Spectator 1 - Red 2 - Blue

gotflag

1 - Red 2 - Blue

Do you have the flag?

emeraldhunt

Number of Chaos Emeralds found.

weapondelay

Delay (if any) to fire the weapon again

tossdelay

Delay (if any) to toss a flag/emeralds again

shielddelay

force shield counter

taunttimer

Delay before you can use the taunt again

Starpost information

long starpostnum

The number of the last starpost you hit

starposttime

Your time when you hit the starpost

starpostangle

Angle that the starpost is facing - you respawn facing this way

starpostbit

List of starposts hit

NiGHTS Stuff

bumpertime

Currently being bounced by MT_NIGHTSBUMPER

nightstime

How long you can fly as NiGHTS.

bonustime

Capsule destroyed, now it's bonus time!

capsule

Go inside the capsule

mare

Current mare

losscount

Number of times you've lost only 1 ring

currentthing

For the object placement mode

onconveyor

You are on a conveyor belt if not zero.

jointime

Timer when player joins game to change skin/color